about summary refs log tree commit diff
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2013-05-25 14:19:10 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2013-05-25 20:33:28 +0200
commit3cb5d86dc68bab4883bf5a7cbc90f3e266237355 (patch)
treef7e3e798447d45179b4169a053f67e0ea3048c14 /cgitrc.5.txt
parentcgit.c: Do not reset HOME after unsetting it. (diff)
downloadcgit-pink-3cb5d86dc68bab4883bf5a7cbc90f3e266237355.tar.gz
cgit-pink-3cb5d86dc68bab4883bf5a7cbc90f3e266237355.zip
ui-summary: Use default branch for readme if : prefix
If the readme value begins with ":", and has no specified branch before
it, use the repository's default branch.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to '')
-rw-r--r--cgitrc.5.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 9b803b3..8a0a9c9 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -505,7 +505,9 @@ repo.readme::
 	A path (relative to <repo.path>) which specifies a file to include
 	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" Default value: <readme>.
+	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. Default value: <readme>.
 
 repo.snapshots::
 	A mask of allowed snapshot-formats for this repo, restricted by the