From: Jonathan Nieder <jrnieder@gmail.com>
Date: Wed, 18 Aug 2010 03:03:21 GMT
Subject: Re: [RFC] Splitting gitweb and build-time configuration variables
Message-ID: <20100818030321.GB21185@burratino>
In-Reply-To: <201008172015.37353.jnareb@gmail.com>

Jakub Narebski wrote:

> 1. Description of build-time configuration variable is in the module
>    that defines it, and each block of variables coming from the same
>    module would have notice where one can find description of those
>    variables
[...]
> 2. Description of build-time configuration variables is in gitweb.perl,
>    and in each module there is comment that full description of those
>    variables can be found there, e.g. (proposal):
> 
>      # Values of those variables are set during build time in 
>      # gitweb/gitweb.perl (main script).  You can find their description
>      # there.
[...]
> 3. Duplicate description of those variables

With #2, a person reading the Makefile can grep for some particular
substitution (++GITWEB_PROJECTROOT++) and quickly find the name and
description of the variable it is used for.  If there were a 1:1
correspondence between the variables in gitweb.perl and the Makefile,
I would even suggest moving the description to the Makefile.

In practice, I suspect the run-time configuration is more important to
people.  That is already fairly well documented in gitweb/README.

Just my two cents,
Jonathan