aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorJason A. Donenfeld2012-10-09 06:56:14 -0400
committerJason A. Donenfeld2012-10-17 16:30:09 +0200
commit521e10c884055c800078e6dada97ccf6c5193aad (patch)
treef4a8398b2d64b171de909d57893441830a280712 /cgitrc.5.txt
parentc366bd6fa88fb7dbe1e42c84d56e2bda0b1682c5 (diff)
downloadcgit-521e10c884055c800078e6dada97ccf6c5193aad.tar.gz
cgit-521e10c884055c800078e6dada97ccf6c5193aad.tar.bz2
cgit-521e10c884055c800078e6dada97ccf6c5193aad.zip
scan-tree: Unify gitweb.* and cgit.* settings into one config option.
After some back and forth with Jamie and René, it looks like the git config semantics are going to be like this: - gitweb.category maps to the cgit repo config key "section" - gitweb.description maps to the cgit repo config key "desc" - gitweb.owner maps to the cgit repo config key "owner" - cgit.* maps to all cgit repo config keys This option can be enabled with "enable-git-config=1", and replaces all previous "enable-gitweb-*" config keys. The order of operations is as follows: - git config settings are applied in the order that they exist in the git config file - if the owner is not set from git config, get the owner using the usual getpwuid call - if the description is not set from git config, look inside the static $path/description file - if section-from-path=1, override whatever previous settings were inside of git config using the section-from-path logic - parse $path/cgitrc for local repo.* settings, that override all previous settings
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt28
1 files changed, 10 insertions, 18 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7e1a93a..278de90 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -110,24 +110,6 @@ enable-filter-overrides::
110 Flag which, when set to "1", allows all filter settings to be 110 Flag which, when set to "1", allows all filter settings to be
111 overridden in repository-specific cgitrc files. Default value: none. 111 overridden in repository-specific cgitrc files. Default value: none.
112 112
113enable-gitweb-desc::
114 If set to "1" and scan-path is enabled, we first check each repository
115 for the git config value "gitweb.description" to determine the owner.
116 Otherwise, the description is read from a file titled "description"
117 inside of the repository directory.
118 Default value: "1". See also: scan-path.
119
120enable-gitweb-owner::
121 If set to "1" and scan-path is enabled, we first check each repository
122 for the git config value "gitweb.owner" to determine the owner.
123 Default value: "1". See also: scan-path.
124
125enable-gitweb-section::
126 If set to "1" and scan-path is enabled, we first check each repository
127 for the git config value "gitweb.category" to determine the repository's
128 section. This value is overridden if section-from-path is enabled.
129 Default value: "1". See also: scan-path section-from-path.
130
131enable-http-clone:: 113enable-http-clone::
132 If set to "1", cgit will act as an dumb HTTP endpoint for git clones. 114 If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
133 If you use an alternate way of serving git repositories, you may wish 115 If you use an alternate way of serving git repositories, you may wish
@@ -163,6 +145,15 @@ enable-tree-linenumbers::
163 Flag which, when set to "1", will make cgit generate linenumber links 145 Flag which, when set to "1", will make cgit generate linenumber links
164 for plaintext blobs printed in the tree view. Default value: "1". 146 for plaintext blobs printed in the tree view. Default value: "1".
165 147
148enable-git-config::
149 Flag which, when set to "1", will allow cgit to use git config to set
150 any repo specific settings. This option is used in conjunction with
151 "scan-path" to augment _repo._ settings. The keys gitweb.owner,
152 gitweb.category, and gitweb.description will map to the cgit keys
153 repo.owner, repo.section, and repo.desc, respectivly. All git config
154 keys that begin with "cgit." will be mapped to the corresponding "repo."
155 key in cgit. Default value: "0". See also: scan-path section-from-path.
156
166favicon:: 157favicon::
167 Url used as link to a shortcut icon for cgit. If specified, it is 158 Url used as link to a shortcut icon for cgit. If specified, it is
168 suggested to use the value "/favicon.ico" since certain browsers will 159 suggested to use the value "/favicon.ico" since certain browsers will
@@ -394,6 +385,7 @@ virtual-root::
394 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 385 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
395 same kind of virtual urls, so this option will probably be deprecated. 386 same kind of virtual urls, so this option will probably be deprecated.
396 387
388
397REPOSITORY SETTINGS 389REPOSITORY SETTINGS
398------------------- 390-------------------
399repo.about-filter:: 391repo.about-filter::