From mboxrd@z Thu Jan 1 00:00:00 1970 From: jamie.couture at gmail.com (Jamie Couture) Date: Mon, 8 Oct 2012 12:48:24 -0400 Subject: [PATCH 2/2] update documentation In-Reply-To: <1349714904-10431-1-git-send-email-jamie.couture@gmail.com> References: <1349714904-10431-1-git-send-email-jamie.couture@gmail.com> Message-ID: <1349714904-10431-2-git-send-email-jamie.couture@gmail.com> - include examples to support gitolite2 and gitolite3 .gitolite.rc Signed-off-by: Jamie Couture --- cgitrc.5.txt | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 902fff3..fadbbbc 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -110,6 +110,13 @@ enable-filter-overrides:: Flag which, when set to "1", allows all filter settings to be overridden in repository-specific cgitrc files. Default value: none. +enable-git-config:: + Flag which, when set to "1", will allow cgit to use git config to set + any repo specific settings. Please read <> to learn more + about which settings are available. This option is used in conjunction with + "scan-path" to override _repo._ settings. Please read <> to + learn how to integrate with gitolite. Default value: "0". + enable-gitweb-desc:: If set to "1" and scan-path is enabled, we first check each repository for the git config value "gitweb.description" to determine the owner. @@ -394,6 +401,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. +[[repo-settings]] REPOSITORY SETTINGS ------------------- repo.about-filter:: @@ -509,6 +517,45 @@ 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". +[[git-config]] +REPOSITORY-SPECIFIC GIT CONFIG +------------------------------ +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 " = "Foo description" + +repo bproject + RW+ = bob + config repo.section = test + config repo.logo = /cgit-data/logo.png + bproject "Bob McPerson " = "Bar description" +...... + +[IMPORTANT] +Unlike cgitrc, we're looking for repo settings with prefix "cgit.". That is, +all options named 'repo.XY' above have to be called 'cgit.XY'. Remember to +edit _.gitolite.rc_ and add the following: + +.gitolite 3 users +....... +$GIT_CONFIG_KEYS = "cgit\..*" +....... + +.gitolite 2 users +....... +$GL_GITCONFIG_KEYS = "cgit\..*" +....... + FILTER API ---------- -- 1.7.11.4