summaryrefslogtreecommitdiffabout
authorJulius Plenz <plenz@cis.fu-berlin.de>2011-03-10 16:03:24 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2011-03-26 14:21:07 (UTC)
commitfacca560d903351ddf1b8a41faafcd1f76de5c7c (patch) (unidiff)
treea122fcc2dea563ce5c803851a48dcb3fa27dfb9c
parent0a799424f682071da9f5b632d1394308e9255bb5 (diff)
downloadcgit-facca560d903351ddf1b8a41faafcd1f76de5c7c.zip
cgit-facca560d903351ddf1b8a41faafcd1f76de5c7c.tar.gz
cgit-facca560d903351ddf1b8a41faafcd1f76de5c7c.tar.bz2
Add advice about scan-path in cgitrc.5.txt
Signed-off-by: Julius Plenz <plenz@cis.fu-berlin.de> Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index be8483c..65b210f 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -266,50 +266,51 @@ root-desc::
266 value: "a fast webinterface for the git dscm". 266 value: "a fast webinterface for the git dscm".
267 267
268root-readme:: 268root-readme::
269 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
270 verbatim below the "about" link on the repository index page. Default 270 verbatim below the "about" link on the repository index page. Default
271 value: none. 271 value: none.
272 272
273root-title:: 273root-title::
274 Text printed as heading on the repository index page. Default value: 274 Text printed as heading on the repository index page. Default value:
275 "Git Repository Browser". 275 "Git Repository Browser".
276 276
277scan-hidden-path:: 277scan-hidden-path::
278 If set to "1" and scan-path is enabled, scan-path will recurse into 278 If set to "1" and scan-path is enabled, scan-path will recurse into
279 directories whose name starts with a period ('.'). Otherwise, 279 directories whose name starts with a period ('.'). Otherwise,
280 scan-path will stay away from such directories (considered as 280 scan-path will stay away from such directories (considered as
281 "hidden"). Note that this does not apply to the ".git" directory in 281 "hidden"). Note that this does not apply to the ".git" directory in
282 non-bare repos. This must be defined prior to scan-path. 282 non-bare repos. This must be defined prior to scan-path.
283 Default value: 0. See also: scan-path. 283 Default value: 0. See also: scan-path.
284 284
285scan-path:: 285scan-path::
286 A path which will be scanned for repositories. If caching is enabled, 286 A path which will be scanned for repositories. If caching is enabled,
287 the result will be cached as a cgitrc include-file in the cache 287 the result will be cached as a cgitrc include-file in the cache
288 directory. If project-list has been defined prior to scan-path, 288 directory. If project-list has been defined prior to scan-path,
289 scan-path loads only the directories listed in the file pointed to by 289 scan-path loads only the directories listed in the file pointed to by
290 project-list. Default value: none. See also: cache-scanrc-ttl, 290 project-list. Be advised that only the global settings taken
291 project-list. 291 before the scan-path directive will be applied to each repository.
292 Default value: none. See also: cache-scanrc-ttl, project-list.
292 293
293section:: 294section::
294 The name of the current repository section - all repositories defined 295 The name of the current repository section - all repositories defined
295 after this option will inherit the current section name. Default value: 296 after this option will inherit the current section name. Default value:
296 none. 297 none.
297 298
298section-from-path:: 299section-from-path::
299 A number which, if specified before scan-path, specifies how many 300 A number which, if specified before scan-path, specifies how many
300 path elements from each repo path to use as a default section name. 301 path elements from each repo path to use as a default section name.
301 If negative, cgit will discard the specified number of path elements 302 If negative, cgit will discard the specified number of path elements
302 above the repo directory. Default value: 0. 303 above the repo directory. Default value: 0.
303 304
304side-by-side-diffs:: 305side-by-side-diffs::
305 If set to "1" shows side-by-side diffs instead of unidiffs per 306 If set to "1" shows side-by-side diffs instead of unidiffs per
306 default. Default value: "0". 307 default. Default value: "0".
307 308
308snapshots:: 309snapshots::
309 Text which specifies the default set of snapshot formats generated by 310 Text which specifies the default set of snapshot formats generated by
310 cgit. The value is a space-separated list of zero or more of the 311 cgit. The value is a space-separated list of zero or more of the
311 values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value: 312 values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
312 none. 313 none.
313 314
314source-filter:: 315source-filter::
315 Specifies a command which will be invoked to format plaintext blobs 316 Specifies a command which will be invoked to format plaintext blobs