path: root/Documentation/gitweb.conf.txt
diff options
authorKrzesimir Nowak <>2013-12-11 11:54:43 (GMT)
committerJunio C Hamano <>2013-12-12 20:37:37 (GMT)
commit8d646a9bac7d64c38060e0c252fd87eba6c4d5cf (patch)
tree92bc7a9bd594c8f304a93b0e3627fa8b243b615c /Documentation/gitweb.conf.txt
parent23faf546ae59d945848389070507bc418de733b6 (diff)
gitweb: Add a feature for adding more branch refs
Allow extra-branch-refs feature to tell gitweb to show refs from additional hierarchies in addition to branches in the list-of-branches view. Signed-off-by: Krzesimir Nowak <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/gitweb.conf.txt')
1 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index e2113d9..db4154f 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -849,6 +849,43 @@ time zones in the form of "+/-HHMM", such as "+0200".
Project specific override is not supported.
+ List of additional directories under "refs" which are going to
+ be used as branch refs. For example if you have a gerrit setup
+ where all branches under refs/heads/ are official,
+ push-after-review ones and branches under refs/sandbox/,
+ refs/wip and refs/other are user ones where permissions are
+ much wider, then you might want to set this variable as
+ follows:
+$feature{'extra-branch-refs'}{'default'} =
+ ['sandbox', 'wip', 'other'];
+This feature can be configured on per-repository basis after setting
+$feature{'extra-branch-refs'}{'override'} to true, via repository's
+`gitweb.extraBranchRefs` configuration variable, which contains a
+space separated list of refs. An example:
+ extraBranchRefs = sandbox wip other
+The gitweb.extraBranchRefs is actually a multi-valued configuration
+variable, so following example is also correct and the result is the
+same as of the snippet above:
+ extraBranchRefs = sandbox
+ extraBranchRefs = wip other
+It is an error to specify a ref that does not pass "git check-ref-format"
+scrutiny. Duplicated values are filtered.