@matheusbsbs / matheus-bagliano / commits / 0d2f7d1c5e

gitweb/INSTALL: Simplify description of GITWEB_CONFIG_SYSTEM

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>

Jakub Narębski committed Apr 13, 2013 at 00:20 UTC 0d2f7d1c5ef20a6872ce1eacb054c576bb048057

1 file changed +5 -8

gitweb/INSTALL

+5 -8

@@ -243,14 +243,11 @@ for gitweb (in gitweb/README), and gitweb.conf(5) manpage.

243 GITWEB_CONFIG_SYSTEM build configuration variable, and override it

244 through the GITWEB_CONFIG_SYSTEM environment variable.

245

246 - Note that if per-instance configuration file exists, then system-wide

247 - configuration is _not used at all_. This is quite untypical and surprising

248 - behavior. On the other hand changing current behavior would break backwards

249 - compatibility and can lead to unexpected changes in gitweb behavior.

250 - Therefore gitweb also looks for common system-wide configuration file,

251 - normally /etc/gitweb-common.conf (set during build time using build time

252 - configuration variable GITWEB_CONFIG_COMMON, set it at runtime using

253 - environment variable with the same name). Settings from per-instance or

246 + Note that the GITWEB_CONFIG_SYSTEM system-wide configuration file is

247 + only used for instances that lack per-instance configuration file.

248 + You can use GITWEB_CONFIG_COMMON common system-wide configuration

249 + file (normally /etc/gitweb-common.conf) to keep common default

250 + settings that apply to all instances. Settings from per-instance or

251 system-wide configuration file override those from common system-wide

252 configuration file.

253