gitweb: Add info about $projectroot and $projects_list to gitweb/README
Those two configuration variables are important enough that it is worth to explicitely write about them in the "Gitweb config file variables" section even if they are usually set during build by GITWEB_PROJECTROOT and GITWEB_LIST build (Makefile) configuration variables. Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jakub Narebski committed
Jan 29, 2008 at 20:52 UTC
d661146ac2ada526e80dbb6234f8f8da6642ffcb
1 file changed
+15
-2
gitweb/README
+15
-2
@@ -129,17 +129,30 @@ descriptions.
129
Gitweb config file variables
130
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131
132
-You can set, among others, the following variables in gitweb config files:
132
+You can set, among others, the following variables in gitweb config files
133
+(with the exception of $projectroot and $projects_list this list does
134
+not include variables usually directly set during build):
135
* $GIT
136
Cure git executable to use. By default set to "$GIT_BINDIR/git", which
137
in turn is by default set to "$(bindir)/git". If you use git from binary
138
package, set this to "/usr/bin/git". This can just be "git" if your
139
webserver has a sensible PATH. If you have multiple git versions
138
- installed it is / can be used to choose which one to use.
140
+ installed it can be used to choose which one to use.
141
* $version
142
Gitweb version, set automatically when creating gitweb.cgi from
143
gitweb.perl. You might want to modify it if you are running modified
144
gitweb.
145
+ * $projectroot
146
+ Absolute filesystem path which will be prepended to project path;
147
+ the path to repository is $projectroot/$project. Set to
148
+ $GITWEB_PROJECTROOT during installation. This variable have to be
149
+ set correctly for gitweb to find repositories.
150
+ * $projects_list
151
+ Source of projects list, either directory to scan, or text file
152
+ with list of repositories (in the "<URI-encoded repository path> SPC
153
+ <URI-encoded repository owner>" format). Set to $GITWEB_LIST
154
+ during installation. If empty, $projectroot is used to scan for
155
+ repositories.
156
* $my_url, $my_uri
157
URL and absolute URL of gitweb script; you might need to set those
158
variables if you are using 'pathinfo' feature: see also below.