undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gitweb/INSTALL: Simplify description of GITWEB_CONFIG_SYSTEM

Browse Source 
The flow of the text describing GITWEB_CONFIG_SYSTEM and
GITWEB_CONFIG_COMMON in gitweb/INSTALL is awkward.  "This is bad. Oh
the other hand, better is broken. Therefore we do this." forces
readers to make multiple guesses while reading: "ok, bad, so you
plan to change it and warn us about upcoming change?  oh, not that,
changing it is bad, so we have to live with it?  oh, not that, there
is another one that is common and that is what we can use".

Better rewrite said paragraph to avoid such a mental roller-coaster in
the first place.

Signed-off-by: Junio Hamano <gitster@pobox.com>
Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jakub Narębski 2013-04-13 00:20:48 +02:00 committed by Junio C Hamano
parent a46221e9ad
commit 0d2f7d1c5e
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
gitweb/INSTALL
View File

@ -243,14 +243,11 @@ for gitweb (in gitweb/README), and gitweb.conf(5) manpage.
GITWEB_CONFIG_SYSTEM build configuration variable, and override it GITWEB_CONFIG_SYSTEM build configuration variable, and override it
through the GITWEB_CONFIG_SYSTEM environment variable. through the GITWEB_CONFIG_SYSTEM environment variable.
Note that if per-instance configuration file exists, then system-wide Note that the GITWEB_CONFIG_SYSTEM system-wide configuration file is
configuration is _not used at all_. This is quite untypical and surprising only used for instances that lack per-instance configuration file.
behavior. On the other hand changing current behavior would break backwards You can use GITWEB_CONFIG_COMMON common system-wide configuration
compatibility and can lead to unexpected changes in gitweb behavior. file (normally /etc/gitweb-common.conf) to keep common default
Therefore gitweb also looks for common system-wide configuration file, settings that apply to all instances. Settings from per-instance or
normally /etc/gitweb-common.conf (set during build time using build time
configuration variable GITWEB_CONFIG_COMMON, set it at runtime using
environment variable with the same name). Settings from per-instance or
system-wide configuration file override those from common system-wide system-wide configuration file override those from common system-wide
configuration file. configuration file.