git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Jakub Narebski <jnareb@gmail.com>
Cc: git@vger.kernel.org, Christian Couder <chriscool@tuxfamily.org>,
	Petr Baudis <pasky@suse.cz>,
	Pavan Kumar Sunkara <pavan.sss1991@gmail.com>,
	John Hawley <warthog9@kernel.org>
Subject: Re: [RFC] Splitting gitweb and build-time configuration variables
Date: Tue, 17 Aug 2010 22:03:21 -0500	[thread overview]
Message-ID: <20100818030321.GB21185@burratino> (raw)
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

  reply	other threads:[~2010-08-18  3:05 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-08-17 18:15 [RFC] Splitting gitweb and build-time configuration variables Jakub Narebski
2010-08-18  3:03 ` Jonathan Nieder [this message]
2010-08-18  8:05   ` Jakub Narebski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20100818030321.GB21185@burratino \
    --to=jrnieder@gmail.com \
    --cc=chriscool@tuxfamily.org \
    --cc=git@vger.kernel.org \
    --cc=jnareb@gmail.com \
    --cc=pasky@suse.cz \
    --cc=pavan.sss1991@gmail.com \
    --cc=warthog9@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).