List for cgit developers and users
 help / color / mirror / Atom feed
From: jamie.couture at gmail.com (Jamie Couture)
Subject: [PATCH 2/2] update documentation
Date: Mon,  8 Oct 2012 12:48:24 -0400	[thread overview]
Message-ID: <1349714904-10431-2-git-send-email-jamie.couture@gmail.com> (raw)
In-Reply-To: <1349714904-10431-1-git-send-email-jamie.couture@gmail.com>

- include examples to support gitolite2 and gitolite3
 .gitolite.rc

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 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 <<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".
+
 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 <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"
+......
+
+[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





  reply	other threads:[~2012-10-08 16:48 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-09-27  1:39 Maintaining My Own Cgit Tree Jason
2012-09-27  4:22 ` william.bell
2012-09-27  9:00   ` Tobias.Bieniek
2012-09-27 15:53   ` webmaster
2012-09-29  0:30 ` [PATCH] Added code to output the age as seconds instead of "0 min." lsworkemail112
2012-09-29  5:20   ` Jason
2012-09-29 18:43     ` lsworkemail112
2012-09-29 18:51       ` Jason
2012-09-29 19:14         ` lsworkemail112
2012-09-29 19:15           ` Jason
2012-09-29 19:17             ` lsworkemail112
2012-09-29 19:16           ` lsworkemail112
2012-09-30  5:51       ` mailings
2012-09-30 17:28         ` lsworkemail112
2012-09-30 17:29         ` Jason
2012-09-30 17:40           ` mailings
2012-09-30 21:06           ` lsworkemail112
2012-09-30 21:33             ` Jason
2012-10-01  6:12               ` mailings
2012-10-02  1:46                 ` lsworkemail112
2012-10-02  2:04                   ` Jason
2012-10-02  2:08                     ` lsworkemail112
2012-10-01 13:56       ` webmaster
2012-10-08 16:48 ` [PATCH 1/2] add git config parsing during scan-path jamie.couture
2012-10-08 16:48   ` jamie.couture [this message]
2012-10-08 21:05     ` [PATCH 2/2] update documentation 
2012-10-08 21:18     ` 
2012-10-08 16:49 ` [PATCH] repolist pagination changes jamie.couture
2012-10-08 21:39   ` Jason
2012-10-08 17:12 ` [PATCH] add tag target to generate ctags jamie.couture
2012-10-08 21:41   ` Jason
2012-10-09 10:56 ` [PATCH] add git config parsing during scan-path jamie.couture
2012-10-09 11:33   ` Jason
2012-10-09 11:15 ` Maintaining My Own Cgit Tree mailings
2012-10-09 11:18   ` Jason

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1349714904-10431-2-git-send-email-jamie.couture@gmail.com \
    --to=cgit@lists.zx2c4.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).