gitweb/INSTALL: GITWEB_CONFIG_SYSTEM is for backward compatibility

Highlight that CONFIG_SYSTEM and /etc/gitweb.conf are meant to be
the fallback configuration file in BUGS section of gitweb.conf
documentation.  This will hopefully help people who expect them to
be a common default, which unfortunately came later in the history.

diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index eb636317be501b6d448f0f7b861952c74b9ff2e0..ea0526ecc4019802b7088316cba9aed401fa6ee8 100644 (file)
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -857,6 +857,13 @@ adding the following lines to your gitweb configuration file:
        $known_snapshot_formats{'zip'}{'disabled'} = 1;
        $known_snapshot_formats{'tgz'}{'compressor'} = ['gzip','-6'];
 
        $known_snapshot_formats{'zip'}{'disabled'} = 1;
        $known_snapshot_formats{'tgz'}{'compressor'} = ['gzip','-6'];
 

+BUGS
+----
+Debugging would be easier if the fallback configuration file
+(`/etc/gitweb.conf`) and environment variable to override its location
+('GITWEB_CONFIG_SYSTEM') had names reflecting their "fallback" role.
+The current names are kept to avoid breaking working setups.
+

 ENVIRONMENT
 -----------
 The location of per-instance and system-wide configuration files can be
 ENVIRONMENT
 -----------
 The location of per-instance and system-wide configuration files can be