aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorChristian Hesse <mail@eworm.de>2022-01-10 10:15:33 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2022-12-19 16:13:58 +0100
commita0f6669bdb74e58b0ddb3f4283209cd5e58c0eb9 (patch)
treed194a8164a9116662eb0f467481470666bf4a17a /cgitrc.5.txt
parentce2062d9e29bf165ba8a70bfc92ff3ab08338d53 (diff)
downloadcgit-a0f6669bdb74e58b0ddb3f4283209cd5e58c0eb9.tar.gz
cgit-a0f6669bdb74e58b0ddb3f4283209cd5e58c0eb9.tar.bz2
cgit-a0f6669bdb74e58b0ddb3f4283209cd5e58c0eb9.zip
about: allow to give 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. Signed-off-by: Christian Hesse <mail@eworm.de>
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 33a6a8c..d9eb3b0 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: