[PATCH v3 2/3] update documentation

Jamie Couture jamie.couture at gmail.com
Fri Nov 25 14:52:54 CET 2011

- include basic example for gitolite big-config, and .gitolite.rc

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
 cgitrc.5.txt |   45 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 45 insertions(+), 0 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 4721c1e..cb1b940 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -146,6 +146,13 @@ enable-tree-linenumbers::
 	Flag which, when set to "1", will make cgit generate linenumber links
 	for plaintext blobs printed in the tree view. Default value: "1".
+    Flag which, when set to "1", will allow cgit to use git config to set
+    any repo specific settings. Please read <<repo-settings>> to learn more
+    about which settings are available. This option is used in conjunction with
+    "scan-path" to override _repo._ settings. Please read <<git-config>> to
+    learn how to integrate with gitolite.  Default value: "0".
 	Url used as link to a shortcut icon for cgit. If specified, it is
 	suggested to use the value "/favicon.ico" since certain browsers will
@@ -360,6 +367,7 @@ virtual-root::
 	NOTE: cgit has recently learned how to use PATH_INFO to achieve the
 	same kind of virtual urls, so this option will probably be deprecated.
@@ -468,6 +476,43 @@ options are only acknowledged in repo-specific config files when
 Note: the "repo." prefix is dropped from the option names in repo-specific
 config files, e.g. "repo.desc" becomes "desc".
+When "scan-path" is used to auto-discover repositories "enable-git-config" will
+allow cgit to look at git config to obtain repo specific settings.
+Configuration is best managed by gitolite's big-config. Please read more about
+http://sitaramc.github.com/gitolite/confother_.html[gitolite repo specific
+commands here].
+.Example gitolite.conf
+repo aproject
+    RW+ = bob
+    config repo.section = applications
+    config repo.defbranch = development
+    aproject "Bob McPerson <bob.mcperson at example.com>" = "Foo description"
+repo bproject
+    RW+ = bob
+    config repo.section = test
+    config repo.logo = /cgit-data/logo.png
+    bproject "Bob McPerson <bob.mcperson at example.com>" = "Bar description"
+Apache users: use an Alias to separate your assets.
+Alias /cgit-data /var/www/htdocs/cgit
+Like cgitrc, we're looking for repo settings with prefix "repo.".
+Remember to edit _.gitolite.rc_ and add the following:
+$GL_GITCONFIG_KEYS = "repo\..*"

More information about the CGit mailing list