git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[RFC] Splitting gitweb and build-time configuration variables

From
Jakub Narebski <jnareb@gmail.com>
Date
Aug 17, 2010, 18:15 UTC
Message-ID
<201008172015.37353.jnareb@gmail.com>

I am planning on picking up and resubmitting "splitting gitweb" series, which was created by Pavan as a prerequisite for adding write and admin support to gitweb ("Splitting gitweb and developing write functionalities (Integrated web client for git)" GSoC 2010 project).

There is a question what to do about gitweb configuration variables which are set during build time, like e.g.:

  # URI of stylesheets
  our @stylesheets = ("++GITWEB_CSS++");
or
  # core git executable to use
  # this can just be "git" if your webserver has a sensible PATH
  our $GIT = "++GIT_BINDIR++/git";

I think it was agreed that _setting_ these variables would be left in gitweb.perl, to have one single place which gathers all such variables, and to have gitweb/Makefile to munge (transform) only a single file.

So those variables would be _declared_ in appropriate gitweb module (Gitweb::Git aka Gitweb::Command, Gitweb::Config, Gitweb::Util etc.) but would be _defined_ (set to value) in gitweb.perl. The final goal is to have gitweb.perl consist only of loading modules, build-time configuration, and starting gitweb (calling run() or similarly named subroutine or method).

The question is where *description* of those build time configuration variables should be (see the above examples). Should it be:

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, like in original patches by Pavan, e.g.:
     # Only configuration variables with build-time overridable
     # defaults are listed below. The complete set of variables
     # with their descriptions is listed in Gitweb::Config.
or
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.
or perhaps
3. Duplicate description of those variables, to have it both in
   appropriate module and in gitweb.perl
What do you think about it?
-- 
Jakub Narebski
Poland
Next: Jonathan Nieder
Message 1 of 3 in “[RFC] Splitting gitweb and build-time configuration variables”
  1. Jakub NarebskiAug 17, 2010
  2. Jonathan NiederAug 18, 2010
  3. Jakub NarebskiAug 18, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.