path: root/gitweb/README
diff options
authorJakub Narebski <>2008-01-29 19:52:32 (GMT)
committerJunio C Hamano <>2008-01-30 06:01:20 (GMT)
commitd661146ac2ada526e80dbb6234f8f8da6642ffcb (patch)
tree0240b26149e49d5ec3d3806d1810e4875e1978d6 /gitweb/README
parenta5d86f7406ecda78b44faf9ab50b7c6e419dba9d (diff)
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 <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'gitweb/README')
1 files changed, 15 insertions, 2 deletions
diff --git a/gitweb/README b/gitweb/README
index b28f59f..4c8bedf 100644
--- a/gitweb/README
+++ b/gitweb/README
@@ -129,17 +129,30 @@ descriptions.
Gitweb config file variables
-You can set, among others, the following variables in gitweb config files:
+You can set, among others, the following variables in gitweb config files
+(with the exception of $projectroot and $projects_list this list does
+not include variables usually directly set during build):
* $GIT
Cure git executable to use. By default set to "$GIT_BINDIR/git", which
in turn is by default set to "$(bindir)/git". If you use git from binary
package, set this to "/usr/bin/git". This can just be "git" if your
webserver has a sensible PATH. If you have multiple git versions
- installed it is / can be used to choose which one to use.
+ installed it can be used to choose which one to use.
* $version
Gitweb version, set automatically when creating gitweb.cgi from
gitweb.perl. You might want to modify it if you are running modified
+ * $projectroot
+ Absolute filesystem path which will be prepended to project path;
+ the path to repository is $projectroot/$project. Set to
+ $GITWEB_PROJECTROOT during installation. This variable have to be
+ set correctly for gitweb to find repositories.
+ * $projects_list
+ Source of projects list, either directory to scan, or text file
+ with list of repositories (in the "<URI-encoded repository path> SPC
+ <URI-encoded repository owner>" format). Set to $GITWEB_LIST
+ during installation. If empty, $projectroot is used to scan for
+ repositories.
* $my_url, $my_uri
URL and absolute URL of gitweb script; you might need to set those
variables if you are using 'pathinfo' feature: see also below.