crtxcr/cgitsb
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cgitrc.5.txt: describe macro expansion of cgitrc options

Browse Source 
This is a new feature in cgit-0.9 which was formerly undocumented.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
This commit is contained in:
Lars Hjemli 2011-06-13 21:58:39 +00:00
parent 2a0c9dcbe8
commit ef13e5eafe
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
cgitrc.5.txt
View File

@ -42,7 +42,7 @@ agefile::
cache-root:: cache-root::
Path used to store the cgit cache entries. Default value: Path used to store the cgit cache entries. Default value:
"/var/cache/cgit". "/var/cache/cgit". See also: "MACRO EXPANSION".
cache-dynamic-ttl:: cache-dynamic-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
@ -155,7 +155,7 @@ header::
include:: include::
Name of a configfile to include before the rest of the current config- Name of a configfile to include before the rest of the current config-
file is parsed. Default value: none. file is parsed. Default value: none. See also: "MACRO EXPANSION".
index-header:: index-header::
The content of the file specified with this option will be included The content of the file specified with this option will be included
@ -237,7 +237,8 @@ noheader::
project-list:: project-list::
A list of subdirectories inside of scan-path, relative to it, that A list of subdirectories inside of scan-path, relative to it, that
should loaded as git repositories. This must be defined prior to should loaded as git repositories. This must be defined prior to
scan-path. Default value: none. See also: scan-path. scan-path. Default value: none. See also: scan-path, "MACRO
EXPANSION".
readme:: readme::
Text which will be used as default value for "repo.readme". Default Text which will be used as default value for "repo.readme". Default
@ -289,7 +290,8 @@ scan-path::
scan-path loads only the directories listed in the file pointed to by scan-path loads only the directories listed in the file pointed to by
project-list. Be advised that only the global settings taken project-list. Be advised that only the global settings taken
before the scan-path directive will be applied to each repository. before the scan-path directive will be applied to each repository.
Default value: none. See also: cache-scanrc-ttl, project-list. Default value: none. See also: cache-scanrc-ttl, project-list,
"MACRO EXPANSION".
section:: section::
The name of the current repository section - all repositories defined The name of the current repository section - all repositories defined
@ -450,6 +452,26 @@ Note: the "repo." prefix is dropped from the option names in repo-specific
config files, e.g. "repo.desc" becomes "desc". config files, e.g. "repo.desc" becomes "desc".
MACRO EXPANSION
---------------
The following cgitrc options supports a simple macro expansion feature,
where tokens prefixed with "$" are replaced with the value of a similary
named environment variable:
- cache-root
- include
- project-list
- scan-path
Macro expansion will also happen on the content of $CGIT_CONFIG, if
defined.
One usage of this feature is virtual hosting, which in its simplest form
can be accomplished by adding the following line to /etc/cgitrc:
include=/etc/cgitrc.d/$HTTP_HOST
EXAMPLE CGITRC FILE EXAMPLE CGITRC FILE
------------------- -------------------