about summary refs log tree commit diff
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorChristian Hesse <mail@eworm.de>2022-01-10 10:18:55 +0100
committerJune McEnroe <june@causal.agency>2022-02-17 17:57:00 -0500
commit129d8a1582b586718a64bbbef393d529b84c7b16 (patch)
tree656aa5e0d6229fe6b40a52e507ad35fd6ea6f6de /cgitrc.5.txt
parentBump version to 1.3.0 (diff)
downloadcgit-pink-129d8a1582b586718a64bbbef393d529b84c7b16.tar.gz
cgit-pink-129d8a1582b586718a64bbbef393d529b84c7b16.zip
Allow to give readme head from query
Reading the README from repository used to be limited to default
branch or a branch given in configuration. Let's allow a branch
from query if not specified explicitly.
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt10
1 files changed, 5 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7dd644a..cafb535 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -579,11 +579,11 @@ repo.readme::
 	verbatim as the "About" page for this repo. You may also specify a
 	git refspec by head or by hash by prepending the refspec followed by
 	a colon. For example, "master:docs/readme.mkd". If the value begins
-	with a colon, i.e. ":docs/readme.rst", the default branch of the
-	repository will be used. Sharing any file will expose that entire
-	directory tree to the "/about/PATH" endpoints, so be sure that there
-	are no non-public files located in the same directory as the readme
-	file. Default value: <readme>.
+	with a colon, i.e. ":docs/readme.rst", the head giving in query or
+	the default branch of the repository will be used. Sharing any file
+	will expose that entire directory tree to the "/about/PATH" endpoints,
+	so be sure that there are no non-public files located in the same
+	directory as the readme file. Default value: <readme>.
 
 repo.section::
 	Override the current section name for this repository. Default value: