summaryrefslogtreecommitdiff
path: root/gitweb/README
diff options
context:
space:
mode:
authorPetr Baudis <pasky@suse.cz>2006-10-07 13:17:47 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-10-08 06:12:12 (GMT)
commit45a3b12cfd3eaa05bbb0954790d5be5b8240a7b5 (patch)
tree0cf1d80e827830676cc5182415607554bc89e42d /gitweb/README
parenta9455919064ab316b7852d0006c1bd771b727f2e (diff)
downloadgit-45a3b12cfd3eaa05bbb0954790d5be5b8240a7b5.zip
git-45a3b12cfd3eaa05bbb0954790d5be5b8240a7b5.tar.gz
git-45a3b12cfd3eaa05bbb0954790d5be5b8240a7b5.tar.bz2
gitweb: Document features better
This expands gitweb/README to talk some more about GITWEB_CONFIG, moves feature-specific documentation in gitweb.cgi to the inside of the %features array, and adds some short description of all the features. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'gitweb/README')
-rw-r--r--gitweb/README16
1 files changed, 15 insertions, 1 deletions
diff --git a/gitweb/README b/gitweb/README
index 27c6dac..abbaf6b 100644
--- a/gitweb/README
+++ b/gitweb/README
@@ -24,11 +24,25 @@ You can specify the following configuration variables when building GIT:
* GITWEB_LOGO
Points to the location where you put git-logo.png on your web server.
* GITWEB_CONFIG
- This file will be loaded using 'require'. If the environment
+ This file will be loaded using 'require' and can be used to override any
+ of the options above as well as some other options - see the top of
+ 'gitweb.cgi' for their full list and description. If the environment
$GITWEB_CONFIG is set when gitweb.cgi is executed the file in the
environment variable will be loaded instead of the file
specified when gitweb.cgi was created.
+Runtime gitweb configuration
+----------------------------
+
+You can adjust gitweb behaviour using the file specified in `GITWEB_CONFIG`
+(defaults to 'gitweb_config.perl' in the same directory as the CGI).
+See the top of 'gitweb.cgi' for the list of variables and some description.
+The most notable thing that is not configurable at compile time are the
+optional features, stored in the '%features' variable. You can find further
+description on how to reconfigure the default features setting in your
+`GITWEB_CONFIG` or per-project in `project.git/config` inside 'gitweb.cgi'.
+
+
Originally written by:
Kay Sievers <kay.sievers@vrfy.org>