author | Johan Herland <johan@herland.net> | 2010-11-15 17:39:50 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2010-11-16 07:18:36 (UTC) |
commit | 9a8d39c668b98464bac97d4e5442966de63f97b2 (patch) (unidiff) | |
tree | ee1a7766d6d9365ae45f694939c20cab811abd84 /cgitrc.5.txt | |
parent | 5a36c2a291a00b59b8ec2f112453e117797c2fe5 (diff) | |
download | cgit-9a8d39c668b98464bac97d4e5442966de63f97b2.zip cgit-9a8d39c668b98464bac97d4e5442966de63f97b2.tar.gz cgit-9a8d39c668b98464bac97d4e5442966de63f97b2.tar.bz2 |
ui-log: Implement support for commit graphs
Teach CGit to print an ASCII art commit graph to the left of the commit
message, similar to 'git log --graph'. The graph adds extra lines (table
rows) to the log when needed to add/remove/shuffle edges in the graph.
When 'showmsg' is enabled, the graph is automatically padded to account
for the extra lines added by the commit message/notes.
This feature is controlled by a new config variable: "enable-commit-graph"
(disabled by default), and individual repos can control it by setting
"repo.enable-commit-graph".
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 75b6584..b45c46b 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -1,189 +1,194 @@ | |||
1 | :man source: cgit | 1 | :man source: cgit |
2 | :man manual: cgit | 2 | :man manual: cgit |
3 | 3 | ||
4 | CGITRC(5) | 4 | CGITRC(5) |
5 | ======== | 5 | ======== |
6 | 6 | ||
7 | 7 | ||
8 | NAME | 8 | NAME |
9 | ---- | 9 | ---- |
10 | cgitrc - runtime configuration for cgit | 10 | cgitrc - runtime configuration for cgit |
11 | 11 | ||
12 | 12 | ||
13 | SYNOPSIS | 13 | SYNOPSIS |
14 | -------- | 14 | -------- |
15 | Cgitrc contains all runtime settings for cgit, including the list of git | 15 | Cgitrc contains all runtime settings for cgit, including the list of git |
16 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank | 16 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank |
17 | lines, and lines starting with '#', are ignored. | 17 | lines, and lines starting with '#', are ignored. |
18 | 18 | ||
19 | 19 | ||
20 | LOCATION | 20 | LOCATION |
21 | -------- | 21 | -------- |
22 | The default location of cgitrc, defined at compile time, is /etc/cgitrc. At | 22 | The default location of cgitrc, defined at compile time, is /etc/cgitrc. At |
23 | runtime, cgit will consult the environment variable CGIT_CONFIG and, if | 23 | runtime, cgit will consult the environment variable CGIT_CONFIG and, if |
24 | defined, use its value instead. | 24 | defined, use its value instead. |
25 | 25 | ||
26 | 26 | ||
27 | GLOBAL SETTINGS | 27 | GLOBAL SETTINGS |
28 | --------------- | 28 | --------------- |
29 | about-filter:: | 29 | about-filter:: |
30 | Specifies a command which will be invoked to format the content of | 30 | Specifies a command which will be invoked to format the content of |
31 | about pages (both top-level and for each repository). The command will | 31 | about pages (both top-level and for each repository). The command will |
32 | get the content of the about-file on its STDIN, and the STDOUT from the | 32 | get the content of the about-file on its STDIN, and the STDOUT from the |
33 | command will be included verbatim on the about page. Default value: | 33 | command will be included verbatim on the about page. Default value: |
34 | none. | 34 | none. |
35 | 35 | ||
36 | agefile:: | 36 | agefile:: |
37 | Specifies a path, relative to each repository path, which can be used | 37 | Specifies a path, relative to each repository path, which can be used |
38 | to specify the date and time of the youngest commit in the repository. | 38 | to specify the date and time of the youngest commit in the repository. |
39 | The first line in the file is used as input to the "parse_date" | 39 | The first line in the file is used as input to the "parse_date" |
40 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 40 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
41 | hh:mm:ss". Default value: "info/web/last-modified". | 41 | hh:mm:ss". Default value: "info/web/last-modified". |
42 | 42 | ||
43 | cache-root:: | 43 | cache-root:: |
44 | Path used to store the cgit cache entries. Default value: | 44 | Path used to store the cgit cache entries. Default value: |
45 | "/var/cache/cgit". | 45 | "/var/cache/cgit". |
46 | 46 | ||
47 | cache-dynamic-ttl:: | 47 | cache-dynamic-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 48 | Number which specifies the time-to-live, in minutes, for the cached |
49 | version of repository pages accessed without a fixed SHA1. Default | 49 | version of repository pages accessed without a fixed SHA1. Default |
50 | value: "5". | 50 | value: "5". |
51 | 51 | ||
52 | cache-repo-ttl:: | 52 | cache-repo-ttl:: |
53 | Number which specifies the time-to-live, in minutes, for the cached | 53 | Number which specifies the time-to-live, in minutes, for the cached |
54 | version of the repository summary page. Default value: "5". | 54 | version of the repository summary page. Default value: "5". |
55 | 55 | ||
56 | cache-root-ttl:: | 56 | cache-root-ttl:: |
57 | Number which specifies the time-to-live, in minutes, for the cached | 57 | Number which specifies the time-to-live, in minutes, for the cached |
58 | version of the repository index page. Default value: "5". | 58 | version of the repository index page. Default value: "5". |
59 | 59 | ||
60 | cache-scanrc-ttl:: | 60 | cache-scanrc-ttl:: |
61 | Number which specifies the time-to-live, in minutes, for the result | 61 | Number which specifies the time-to-live, in minutes, for the result |
62 | of scanning a path for git repositories. Default value: "15". | 62 | of scanning a path for git repositories. Default value: "15". |
63 | 63 | ||
64 | cache-size:: | 64 | cache-size:: |
65 | The maximum number of entries in the cgit cache. Default value: "0" | 65 | The maximum number of entries in the cgit cache. Default value: "0" |
66 | (i.e. caching is disabled). | 66 | (i.e. caching is disabled). |
67 | 67 | ||
68 | cache-static-ttl:: | 68 | cache-static-ttl:: |
69 | Number which specifies the time-to-live, in minutes, for the cached | 69 | Number which specifies the time-to-live, in minutes, for the cached |
70 | version of repository pages accessed with a fixed SHA1. Default value: | 70 | version of repository pages accessed with a fixed SHA1. Default value: |
71 | "5". | 71 | "5". |
72 | 72 | ||
73 | clone-prefix:: | 73 | clone-prefix:: |
74 | Space-separated list of common prefixes which, when combined with a | 74 | Space-separated list of common prefixes which, when combined with a |
75 | repository url, generates valid clone urls for the repository. This | 75 | repository url, generates valid clone urls for the repository. This |
76 | setting is only used if `repo.clone-url` is unspecified. Default value: | 76 | setting is only used if `repo.clone-url` is unspecified. Default value: |
77 | none. | 77 | none. |
78 | 78 | ||
79 | commit-filter:: | 79 | commit-filter:: |
80 | Specifies a command which will be invoked to format commit messages. | 80 | Specifies a command which will be invoked to format commit messages. |
81 | The command will get the message on its STDIN, and the STDOUT from the | 81 | The command will get the message on its STDIN, and the STDOUT from the |
82 | command will be included verbatim as the commit message, i.e. this can | 82 | command will be included verbatim as the commit message, i.e. this can |
83 | be used to implement bugtracker integration. Default value: none. | 83 | be used to implement bugtracker integration. Default value: none. |
84 | 84 | ||
85 | css:: | 85 | css:: |
86 | Url which specifies the css document to include in all cgit pages. | 86 | Url which specifies the css document to include in all cgit pages. |
87 | Default value: "/cgit.css". | 87 | Default value: "/cgit.css". |
88 | 88 | ||
89 | embedded:: | 89 | embedded:: |
90 | Flag which, when set to "1", will make cgit generate a html fragment | 90 | Flag which, when set to "1", will make cgit generate a html fragment |
91 | suitable for embedding in other html pages. Default value: none. See | 91 | suitable for embedding in other html pages. Default value: none. See |
92 | also: "noheader". | 92 | also: "noheader". |
93 | 93 | ||
94 | enable-commit-graph:: | ||
95 | Flag which, when set to "1", will make cgit print an ASCII-art commit | ||
96 | history graph to the left of the commit messages in the repository | ||
97 | log page. Default value: "0". | ||
98 | |||
94 | enable-filter-overrides:: | 99 | enable-filter-overrides:: |
95 | Flag which, when set to "1", allows all filter settings to be | 100 | Flag which, when set to "1", allows all filter settings to be |
96 | overridden in repository-specific cgitrc files. Default value: none. | 101 | overridden in repository-specific cgitrc files. Default value: none. |
97 | 102 | ||
98 | enable-gitweb-owner:: | 103 | enable-gitweb-owner:: |
99 | If set to "1" and scan-path is enabled, we first check each repository | 104 | If set to "1" and scan-path is enabled, we first check each repository |
100 | for the git config value "gitweb.owner" to determine the owner. | 105 | for the git config value "gitweb.owner" to determine the owner. |
101 | Default value: "1". See also: scan-path. | 106 | Default value: "1". See also: scan-path. |
102 | 107 | ||
103 | enable-index-links:: | 108 | enable-index-links:: |
104 | Flag which, when set to "1", will make cgit generate extra links for | 109 | Flag which, when set to "1", will make cgit generate extra links for |
105 | each repo in the repository index (specifically, to the "summary", | 110 | each repo in the repository index (specifically, to the "summary", |
106 | "commit" and "tree" pages). Default value: "0". | 111 | "commit" and "tree" pages). Default value: "0". |
107 | 112 | ||
108 | enable-log-filecount:: | 113 | enable-log-filecount:: |
109 | Flag which, when set to "1", will make cgit print the number of | 114 | Flag which, when set to "1", will make cgit print the number of |
110 | modified files for each commit on the repository log page. Default | 115 | modified files for each commit on the repository log page. Default |
111 | value: "0". | 116 | value: "0". |
112 | 117 | ||
113 | enable-log-linecount:: | 118 | enable-log-linecount:: |
114 | Flag which, when set to "1", will make cgit print the number of added | 119 | Flag which, when set to "1", will make cgit print the number of added |
115 | and removed lines for each commit on the repository log page. Default | 120 | and removed lines for each commit on the repository log page. Default |
116 | value: "0". | 121 | value: "0". |
117 | 122 | ||
118 | enable-remote-branches:: | 123 | enable-remote-branches:: |
119 | Flag which, when set to "1", will make cgit display remote branches | 124 | Flag which, when set to "1", will make cgit display remote branches |
120 | in the summary and refs views. Default value: "0". See also: | 125 | in the summary and refs views. Default value: "0". See also: |
121 | "repo.enable-remote-branches". | 126 | "repo.enable-remote-branches". |
122 | 127 | ||
123 | enable-subject-links:: | 128 | enable-subject-links:: |
124 | Flag which, when set to "1", will make cgit use the subject of the | 129 | Flag which, when set to "1", will make cgit use the subject of the |
125 | parent commit as link text when generating links to parent commits | 130 | parent commit as link text when generating links to parent commits |
126 | in commit view. Default value: "0". See also: | 131 | in commit view. Default value: "0". See also: |
127 | "repo.enable-subject-links". | 132 | "repo.enable-subject-links". |
128 | 133 | ||
129 | enable-tree-linenumbers:: | 134 | enable-tree-linenumbers:: |
130 | Flag which, when set to "1", will make cgit generate linenumber links | 135 | Flag which, when set to "1", will make cgit generate linenumber links |
131 | for plaintext blobs printed in the tree view. Default value: "1". | 136 | for plaintext blobs printed in the tree view. Default value: "1". |
132 | 137 | ||
133 | favicon:: | 138 | favicon:: |
134 | Url used as link to a shortcut icon for cgit. If specified, it is | 139 | Url used as link to a shortcut icon for cgit. If specified, it is |
135 | suggested to use the value "/favicon.ico" since certain browsers will | 140 | suggested to use the value "/favicon.ico" since certain browsers will |
136 | ignore other values. Default value: none. | 141 | ignore other values. Default value: none. |
137 | 142 | ||
138 | footer:: | 143 | footer:: |
139 | The content of the file specified with this option will be included | 144 | The content of the file specified with this option will be included |
140 | verbatim at the bottom of all pages (i.e. it replaces the standard | 145 | verbatim at the bottom of all pages (i.e. it replaces the standard |
141 | "generated by..." message. Default value: none. | 146 | "generated by..." message. Default value: none. |
142 | 147 | ||
143 | head-include:: | 148 | head-include:: |
144 | The content of the file specified with this option will be included | 149 | The content of the file specified with this option will be included |
145 | verbatim in the html HEAD section on all pages. Default value: none. | 150 | verbatim in the html HEAD section on all pages. Default value: none. |
146 | 151 | ||
147 | header:: | 152 | header:: |
148 | The content of the file specified with this option will be included | 153 | The content of the file specified with this option will be included |
149 | verbatim at the top of all pages. Default value: none. | 154 | verbatim at the top of all pages. Default value: none. |
150 | 155 | ||
151 | include:: | 156 | include:: |
152 | Name of a configfile to include before the rest of the current config- | 157 | Name of a configfile to include before the rest of the current config- |
153 | file is parsed. Default value: none. | 158 | file is parsed. Default value: none. |
154 | 159 | ||
155 | index-header:: | 160 | index-header:: |
156 | The content of the file specified with this option will be included | 161 | The content of the file specified with this option will be included |
157 | verbatim above the repository index. This setting is deprecated, and | 162 | verbatim above the repository index. This setting is deprecated, and |
158 | will not be supported by cgit-1.0 (use root-readme instead). Default | 163 | will not be supported by cgit-1.0 (use root-readme instead). Default |
159 | value: none. | 164 | value: none. |
160 | 165 | ||
161 | index-info:: | 166 | index-info:: |
162 | The content of the file specified with this option will be included | 167 | The content of the file specified with this option will be included |
163 | verbatim below the heading on the repository index page. This setting | 168 | verbatim below the heading on the repository index page. This setting |
164 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 169 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
165 | instead). Default value: none. | 170 | instead). Default value: none. |
166 | 171 | ||
167 | local-time:: | 172 | local-time:: |
168 | Flag which, if set to "1", makes cgit print commit and tag times in the | 173 | Flag which, if set to "1", makes cgit print commit and tag times in the |
169 | servers timezone. Default value: "0". | 174 | servers timezone. Default value: "0". |
170 | 175 | ||
171 | logo:: | 176 | logo:: |
172 | Url which specifies the source of an image which will be used as a logo | 177 | Url which specifies the source of an image which will be used as a logo |
173 | on all cgit pages. Default value: "/cgit.png". | 178 | on all cgit pages. Default value: "/cgit.png". |
174 | 179 | ||
175 | logo-link:: | 180 | logo-link:: |
176 | Url loaded when clicking on the cgit logo image. If unspecified the | 181 | Url loaded when clicking on the cgit logo image. If unspecified the |
177 | calculated url of the repository index page will be used. Default | 182 | calculated url of the repository index page will be used. Default |
178 | value: none. | 183 | value: none. |
179 | 184 | ||
180 | max-atom-items:: | 185 | max-atom-items:: |
181 | Specifies the number of items to display in atom feeds view. Default | 186 | Specifies the number of items to display in atom feeds view. Default |
182 | value: "10". | 187 | value: "10". |
183 | 188 | ||
184 | max-commit-count:: | 189 | max-commit-count:: |
185 | Specifies the number of entries to list per page in "log" view. Default | 190 | Specifies the number of entries to list per page in "log" view. Default |
186 | value: "50". | 191 | value: "50". |
187 | 192 | ||
188 | max-message-length:: | 193 | max-message-length:: |
189 | Specifies the maximum number of commit message characters to display in | 194 | Specifies the maximum number of commit message characters to display in |
@@ -261,279 +266,287 @@ root-desc:: | |||
261 | value: "a fast webinterface for the git dscm". | 266 | value: "a fast webinterface for the git dscm". |
262 | 267 | ||
263 | root-readme:: | 268 | root-readme:: |
264 | The content of the file specified with this option will be included | 269 | The content of the file specified with this option will be included |
265 | verbatim below the "about" link on the repository index page. Default | 270 | verbatim below the "about" link on the repository index page. Default |
266 | value: none. | 271 | value: none. |
267 | 272 | ||
268 | root-title:: | 273 | root-title:: |
269 | Text printed as heading on the repository index page. Default value: | 274 | Text printed as heading on the repository index page. Default value: |
270 | "Git Repository Browser". | 275 | "Git Repository Browser". |
271 | 276 | ||
272 | scan-path:: | 277 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 278 | A path which will be scanned for repositories. If caching is enabled, |
274 | the result will be cached as a cgitrc include-file in the cache | 279 | the result will be cached as a cgitrc include-file in the cache |
275 | directory. If project-list has been defined prior to scan-path, | 280 | directory. If project-list has been defined prior to scan-path, |
276 | scan-path loads only the directories listed in the file pointed to by | 281 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 282 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 283 | project-list. |
279 | 284 | ||
280 | section:: | 285 | section:: |
281 | The name of the current repository section - all repositories defined | 286 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 287 | after this option will inherit the current section name. Default value: |
283 | none. | 288 | none. |
284 | 289 | ||
285 | section-from-path:: | 290 | section-from-path:: |
286 | A number which, if specified before scan-path, specifies how many | 291 | A number which, if specified before scan-path, specifies how many |
287 | path elements from each repo path to use as a default section name. | 292 | path elements from each repo path to use as a default section name. |
288 | If negative, cgit will discard the specified number of path elements | 293 | If negative, cgit will discard the specified number of path elements |
289 | above the repo directory. Default value: 0. | 294 | above the repo directory. Default value: 0. |
290 | 295 | ||
291 | side-by-side-diffs:: | 296 | side-by-side-diffs:: |
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | 297 | If set to "1" shows side-by-side diffs instead of unidiffs per |
293 | default. Default value: "0". | 298 | default. Default value: "0". |
294 | 299 | ||
295 | snapshots:: | 300 | snapshots:: |
296 | Text which specifies the default set of snapshot formats generated by | 301 | Text which specifies the default set of snapshot formats generated by |
297 | cgit. The value is a space-separated list of zero or more of the | 302 | cgit. The value is a space-separated list of zero or more of the |
298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 303 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
299 | 304 | ||
300 | source-filter:: | 305 | source-filter:: |
301 | Specifies a command which will be invoked to format plaintext blobs | 306 | Specifies a command which will be invoked to format plaintext blobs |
302 | in the tree view. The command will get the blob content on its STDIN | 307 | in the tree view. The command will get the blob content on its STDIN |
303 | and the name of the blob as its only command line argument. The STDOUT | 308 | and the name of the blob as its only command line argument. The STDOUT |
304 | from the command will be included verbatim as the blob contents, i.e. | 309 | from the command will be included verbatim as the blob contents, i.e. |
305 | this can be used to implement e.g. syntax highlighting. Default value: | 310 | this can be used to implement e.g. syntax highlighting. Default value: |
306 | none. | 311 | none. |
307 | 312 | ||
308 | summary-branches:: | 313 | summary-branches:: |
309 | Specifies the number of branches to display in the repository "summary" | 314 | Specifies the number of branches to display in the repository "summary" |
310 | view. Default value: "10". | 315 | view. Default value: "10". |
311 | 316 | ||
312 | summary-log:: | 317 | summary-log:: |
313 | Specifies the number of log entries to display in the repository | 318 | Specifies the number of log entries to display in the repository |
314 | "summary" view. Default value: "10". | 319 | "summary" view. Default value: "10". |
315 | 320 | ||
316 | summary-tags:: | 321 | summary-tags:: |
317 | Specifies the number of tags to display in the repository "summary" | 322 | Specifies the number of tags to display in the repository "summary" |
318 | view. Default value: "10". | 323 | view. Default value: "10". |
319 | 324 | ||
320 | strict-export:: | 325 | strict-export:: |
321 | Filename which, if specified, needs to be present within the repository | 326 | Filename which, if specified, needs to be present within the repository |
322 | for cgit to allow access to that repository. This can be used to emulate | 327 | for cgit to allow access to that repository. This can be used to emulate |
323 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | 328 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's |
324 | repositories to match those exported by git-daemon. This option MUST come | 329 | repositories to match those exported by git-daemon. This option MUST come |
325 | before 'scan-path'. | 330 | before 'scan-path'. |
326 | 331 | ||
327 | virtual-root:: | 332 | virtual-root:: |
328 | Url which, if specified, will be used as root for all cgit links. It | 333 | Url which, if specified, will be used as root for all cgit links. It |
329 | will also cause cgit to generate 'virtual urls', i.e. urls like | 334 | will also cause cgit to generate 'virtual urls', i.e. urls like |
330 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 335 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
331 | value: none. | 336 | value: none. |
332 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 337 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
333 | same kind of virtual urls, so this option will probably be deprecated. | 338 | same kind of virtual urls, so this option will probably be deprecated. |
334 | 339 | ||
335 | REPOSITORY SETTINGS | 340 | REPOSITORY SETTINGS |
336 | ------------------- | 341 | ------------------- |
337 | repo.about-filter:: | 342 | repo.about-filter:: |
338 | Override the default about-filter. Default value: none. See also: | 343 | Override the default about-filter. Default value: none. See also: |
339 | "enable-filter-overrides". | 344 | "enable-filter-overrides". |
340 | 345 | ||
341 | repo.clone-url:: | 346 | repo.clone-url:: |
342 | A list of space-separated urls which can be used to clone this repo. | 347 | A list of space-separated urls which can be used to clone this repo. |
343 | Default value: none. | 348 | Default value: none. |
344 | 349 | ||
345 | repo.commit-filter:: | 350 | repo.commit-filter:: |
346 | Override the default commit-filter. Default value: none. See also: | 351 | Override the default commit-filter. Default value: none. See also: |
347 | "enable-filter-overrides". | 352 | "enable-filter-overrides". |
348 | 353 | ||
349 | repo.defbranch:: | 354 | repo.defbranch:: |
350 | The name of the default branch for this repository. If no such branch | 355 | The name of the default branch for this repository. If no such branch |
351 | exists in the repository, the first branch name (when sorted) is used | 356 | exists in the repository, the first branch name (when sorted) is used |
352 | as default instead. Default value: "master". | 357 | as default instead. Default value: "master". |
353 | 358 | ||
354 | repo.desc:: | 359 | repo.desc:: |
355 | The value to show as repository description. Default value: none. | 360 | The value to show as repository description. Default value: none. |
356 | 361 | ||
362 | repo.enable-commit-graph:: | ||
363 | A flag which can be used to disable the global setting | ||
364 | `enable-commit-graph'. Default value: none. | ||
365 | |||
357 | repo.enable-log-filecount:: | 366 | repo.enable-log-filecount:: |
358 | A flag which can be used to disable the global setting | 367 | A flag which can be used to disable the global setting |
359 | `enable-log-filecount'. Default value: none. | 368 | `enable-log-filecount'. Default value: none. |
360 | 369 | ||
361 | repo.enable-log-linecount:: | 370 | repo.enable-log-linecount:: |
362 | A flag which can be used to disable the global setting | 371 | A flag which can be used to disable the global setting |
363 | `enable-log-linecount'. Default value: none. | 372 | `enable-log-linecount'. Default value: none. |
364 | 373 | ||
365 | repo.enable-remote-branches:: | 374 | repo.enable-remote-branches:: |
366 | Flag which, when set to "1", will make cgit display remote branches | 375 | Flag which, when set to "1", will make cgit display remote branches |
367 | in the summary and refs views. Default value: <enable-remote-branches>. | 376 | in the summary and refs views. Default value: <enable-remote-branches>. |
368 | 377 | ||
369 | repo.enable-subject-links:: | 378 | repo.enable-subject-links:: |
370 | A flag which can be used to override the global setting | 379 | A flag which can be used to override the global setting |
371 | `enable-subject-links'. Default value: none. | 380 | `enable-subject-links'. Default value: none. |
372 | 381 | ||
373 | repo.max-stats:: | 382 | repo.max-stats:: |
374 | Override the default maximum statistics period. Valid values are equal | 383 | Override the default maximum statistics period. Valid values are equal |
375 | to the values specified for the global "max-stats" setting. Default | 384 | to the values specified for the global "max-stats" setting. Default |
376 | value: none. | 385 | value: none. |
377 | 386 | ||
378 | repo.name:: | 387 | repo.name:: |
379 | The value to show as repository name. Default value: <repo.url>. | 388 | The value to show as repository name. Default value: <repo.url>. |
380 | 389 | ||
381 | repo.owner:: | 390 | repo.owner:: |
382 | A value used to identify the owner of the repository. Default value: | 391 | A value used to identify the owner of the repository. Default value: |
383 | none. | 392 | none. |
384 | 393 | ||
385 | repo.path:: | 394 | repo.path:: |
386 | An absolute path to the repository directory. For non-bare repositories | 395 | An absolute path to the repository directory. For non-bare repositories |
387 | this is the .git-directory. Default value: none. | 396 | this is the .git-directory. Default value: none. |
388 | 397 | ||
389 | repo.readme:: | 398 | repo.readme:: |
390 | A path (relative to <repo.path>) which specifies a file to include | 399 | A path (relative to <repo.path>) which specifies a file to include |
391 | verbatim as the "About" page for this repo. You may also specify a | 400 | verbatim as the "About" page for this repo. You may also specify a |
392 | git refspec by head or by hash by prepending the refspec followed by | 401 | git refspec by head or by hash by prepending the refspec followed by |
393 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. | 402 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |
394 | 403 | ||
395 | repo.snapshots:: | 404 | repo.snapshots:: |
396 | A mask of allowed snapshot-formats for this repo, restricted by the | 405 | A mask of allowed snapshot-formats for this repo, restricted by the |
397 | "snapshots" global setting. Default value: <snapshots>. | 406 | "snapshots" global setting. Default value: <snapshots>. |
398 | 407 | ||
399 | repo.section:: | 408 | repo.section:: |
400 | Override the current section name for this repository. Default value: | 409 | Override the current section name for this repository. Default value: |
401 | none. | 410 | none. |
402 | 411 | ||
403 | repo.source-filter:: | 412 | repo.source-filter:: |
404 | Override the default source-filter. Default value: none. See also: | 413 | Override the default source-filter. Default value: none. See also: |
405 | "enable-filter-overrides". | 414 | "enable-filter-overrides". |
406 | 415 | ||
407 | repo.url:: | 416 | repo.url:: |
408 | The relative url used to access the repository. This must be the first | 417 | The relative url used to access the repository. This must be the first |
409 | setting specified for each repo. Default value: none. | 418 | setting specified for each repo. Default value: none. |
410 | 419 | ||
411 | 420 | ||
412 | REPOSITORY-SPECIFIC CGITRC FILE | 421 | REPOSITORY-SPECIFIC CGITRC FILE |
413 | ------------------------------- | 422 | ------------------------------- |
414 | When the option "scan-path" is used to auto-discover git repositories, cgit | 423 | When the option "scan-path" is used to auto-discover git repositories, cgit |
415 | will try to parse the file "cgitrc" within any found repository. Such a | 424 | will try to parse the file "cgitrc" within any found repository. Such a |
416 | repo-specific config file may contain any of the repo-specific options | 425 | repo-specific config file may contain any of the repo-specific options |
417 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 426 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
418 | options are only acknowledged in repo-specific config files when | 427 | options are only acknowledged in repo-specific config files when |
419 | "enable-filter-overrides" is set to "1". | 428 | "enable-filter-overrides" is set to "1". |
420 | 429 | ||
421 | Note: the "repo." prefix is dropped from the option names in repo-specific | 430 | Note: the "repo." prefix is dropped from the option names in repo-specific |
422 | config files, e.g. "repo.desc" becomes "desc". | 431 | config files, e.g. "repo.desc" becomes "desc". |
423 | 432 | ||
424 | 433 | ||
425 | EXAMPLE CGITRC FILE | 434 | EXAMPLE CGITRC FILE |
426 | ------------------- | 435 | ------------------- |
427 | 436 | ||
428 | .... | 437 | .... |
429 | # Enable caching of up to 1000 output entriess | 438 | # Enable caching of up to 1000 output entriess |
430 | cache-size=1000 | 439 | cache-size=1000 |
431 | 440 | ||
432 | 441 | ||
433 | # Specify some default clone prefixes | 442 | # Specify some default clone prefixes |
434 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 443 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
435 | 444 | ||
436 | # Specify the css url | 445 | # Specify the css url |
437 | css=/css/cgit.css | 446 | css=/css/cgit.css |
438 | 447 | ||
439 | 448 | ||
440 | # Show extra links for each repository on the index page | 449 | # Show extra links for each repository on the index page |
441 | enable-index-links=1 | 450 | enable-index-links=1 |
442 | 451 | ||
443 | 452 | ||
453 | # Enable ASCII art commit history graph on the log pages | ||
454 | enable-commit-graph=1 | ||
455 | |||
456 | |||
444 | # Show number of affected files per commit on the log pages | 457 | # Show number of affected files per commit on the log pages |
445 | enable-log-filecount=1 | 458 | enable-log-filecount=1 |
446 | 459 | ||
447 | 460 | ||
448 | # Show number of added/removed lines per commit on the log pages | 461 | # Show number of added/removed lines per commit on the log pages |
449 | enable-log-linecount=1 | 462 | enable-log-linecount=1 |
450 | 463 | ||
451 | 464 | ||
452 | # Add a cgit favicon | 465 | # Add a cgit favicon |
453 | favicon=/favicon.ico | 466 | favicon=/favicon.ico |
454 | 467 | ||
455 | 468 | ||
456 | # Use a custom logo | 469 | # Use a custom logo |
457 | logo=/img/mylogo.png | 470 | logo=/img/mylogo.png |
458 | 471 | ||
459 | 472 | ||
460 | # Enable statistics per week, month and quarter | 473 | # Enable statistics per week, month and quarter |
461 | max-stats=quarter | 474 | max-stats=quarter |
462 | 475 | ||
463 | 476 | ||
464 | # Set the title and heading of the repository index page | 477 | # Set the title and heading of the repository index page |
465 | root-title=foobar.com git repositories | 478 | root-title=foobar.com git repositories |
466 | 479 | ||
467 | 480 | ||
468 | # Set a subheading for the repository index page | 481 | # Set a subheading for the repository index page |
469 | root-desc=tracking the foobar development | 482 | root-desc=tracking the foobar development |
470 | 483 | ||
471 | 484 | ||
472 | # Include some more info about foobar.com on the index page | 485 | # Include some more info about foobar.com on the index page |
473 | root-readme=/var/www/htdocs/about.html | 486 | root-readme=/var/www/htdocs/about.html |
474 | 487 | ||
475 | 488 | ||
476 | # Allow download of tar.gz, tar.bz2 and zip-files | 489 | # Allow download of tar.gz, tar.bz2 and zip-files |
477 | snapshots=tar.gz tar.bz2 zip | 490 | snapshots=tar.gz tar.bz2 zip |
478 | 491 | ||
479 | 492 | ||
480 | ## | 493 | ## |
481 | ## List of common mimetypes | 494 | ## List of common mimetypes |
482 | ## | 495 | ## |
483 | 496 | ||
484 | mimetype.gif=image/gif | 497 | mimetype.gif=image/gif |
485 | mimetype.html=text/html | 498 | mimetype.html=text/html |
486 | mimetype.jpg=image/jpeg | 499 | mimetype.jpg=image/jpeg |
487 | mimetype.jpeg=image/jpeg | 500 | mimetype.jpeg=image/jpeg |
488 | mimetype.pdf=application/pdf | 501 | mimetype.pdf=application/pdf |
489 | mimetype.png=image/png | 502 | mimetype.png=image/png |
490 | mimetype.svg=image/svg+xml | 503 | mimetype.svg=image/svg+xml |
491 | 504 | ||
492 | 505 | ||
493 | ## | 506 | ## |
494 | ## List of repositories. | 507 | ## List of repositories. |
495 | ## PS: Any repositories listed when section is unset will not be | 508 | ## PS: Any repositories listed when section is unset will not be |
496 | ## displayed under a section heading | 509 | ## displayed under a section heading |
497 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 510 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
498 | ## and included like this: | 511 | ## and included like this: |
499 | ## include=/etc/cgitrepos | 512 | ## include=/etc/cgitrepos |
500 | ## | 513 | ## |
501 | 514 | ||
502 | 515 | ||
503 | repo.url=foo | 516 | repo.url=foo |
504 | repo.path=/pub/git/foo.git | 517 | repo.path=/pub/git/foo.git |
505 | repo.desc=the master foo repository | 518 | repo.desc=the master foo repository |
506 | repo.owner=fooman@foobar.com | 519 | repo.owner=fooman@foobar.com |
507 | repo.readme=info/web/about.html | 520 | repo.readme=info/web/about.html |
508 | 521 | ||
509 | 522 | ||
510 | repo.url=bar | 523 | repo.url=bar |
511 | repo.path=/pub/git/bar.git | 524 | repo.path=/pub/git/bar.git |
512 | repo.desc=the bars for your foo | 525 | repo.desc=the bars for your foo |
513 | repo.owner=barman@foobar.com | 526 | repo.owner=barman@foobar.com |
514 | repo.readme=info/web/about.html | 527 | repo.readme=info/web/about.html |
515 | 528 | ||
516 | 529 | ||
517 | # The next repositories will be displayed under the 'extras' heading | 530 | # The next repositories will be displayed under the 'extras' heading |
518 | section=extras | 531 | section=extras |
519 | 532 | ||
520 | 533 | ||
521 | repo.url=baz | 534 | repo.url=baz |
522 | repo.path=/pub/git/baz.git | 535 | repo.path=/pub/git/baz.git |
523 | repo.desc=a set of extensions for bar users | 536 | repo.desc=a set of extensions for bar users |
524 | 537 | ||
525 | repo.url=wiz | 538 | repo.url=wiz |
526 | repo.path=/pub/git/wiz.git | 539 | repo.path=/pub/git/wiz.git |
527 | repo.desc=the wizard of foo | 540 | repo.desc=the wizard of foo |
528 | 541 | ||
529 | 542 | ||
530 | # Add some mirrored repositories | 543 | # Add some mirrored repositories |
531 | section=mirrors | 544 | section=mirrors |
532 | 545 | ||
533 | 546 | ||
534 | repo.url=git | 547 | repo.url=git |
535 | repo.path=/pub/git/git.git | 548 | repo.path=/pub/git/git.git |
536 | repo.desc=the dscm | 549 | repo.desc=the dscm |
537 | 550 | ||
538 | 551 | ||
539 | repo.url=linux | 552 | repo.url=linux |