{"thread":{"id":"27536","subject":"[PATCH 0/2] Improving gitweb documentation","startedAt":"2011-06-02T14:55:51Z","lastAt":"2011-06-03T16:31:48Z","messageCount":6,"participants":["Jakub Narebski","Junio C Hamano","Øyvind A. Holm"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"169199","messageId":"1307026553-1181-1-git-send-email-jnareb@gmail.com","threadId":"27536","inReplyTo":null,"subject":"[PATCH 0/2] Improving gitweb documentation","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2011-06-02T14:55:51Z","receivedAt":"2011-06-02T14:55:51Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"This is fall off from my work on adding continuing Drew Northup work\nof adding gitweb.conf(5) and gitweb(1) manpages (the latter my\naddition).\n\nI see that I missed feature freeze... and this is not strictly bugfix.\nOh, well,...\n\nJakub Narebski (2):\n  gitweb: Move information about installation from README to INSTALL\n  gitweb: Describe CSSMIN and JSMIN in gitweb/INSTALL\n\n gitweb/INSTALL |  122 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-\n gitweb/README  |  114 ----------------------------------------------------\n 2 files changed, 120 insertions(+), 116 deletions(-)\n\n-- \n1.7.5\n"},{"id":"169200","messageId":"1307026553-1181-2-git-send-email-jnareb@gmail.com","threadId":"27536","inReplyTo":"1307026553-1181-1-git-send-email-jnareb@gmail.com","subject":"[PATCH 1/2] gitweb: Move information about installation from README to INSTALL","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2011-06-02T14:55:52Z","receivedAt":"2011-06-02T14:55:52Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Almost straightformard moving of \"How to configure gitweb for your\nlocal system\" section from gitweb/README to gitweb/INSTALL, as it is\nabout build time configuration.  Updated references to it.\n\nSigned-off-by: Jakub Narebski <jnareb@gmail.com>\n---\n gitweb/INSTALL |  115 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-\n gitweb/README  |  114 -------------------------------------------------------\n 2 files changed, 113 insertions(+), 116 deletions(-)\n\ndiff --git a/gitweb/INSTALL b/gitweb/INSTALL\nindex 4964a67..32a52b7 100644\n--- a/gitweb/INSTALL\n+++ b/gitweb/INSTALL\n@@ -28,8 +28,7 @@ scripts).\n Build time configuration\n ------------------------\n \n-See also \"How to configure gitweb for your local system\" in README\n-file for gitweb (in gitweb/README).\n+See also \"How to configure gitweb for your local system\" section below.\n \n - There are many configuration variables which affect building of\n   gitweb.cgi; see \"default configuration for gitweb\" section in main\n@@ -73,6 +72,118 @@ file for gitweb (in gitweb/README).\n   substitute gitweb.min.js and gitweb.min.css for all uses of gitweb.js and\n   gitweb.css in the help files.\n \n+\n+How to configure gitweb for your local system\n+---------------------------------------------\n+\n+You can specify the following configuration variables when building GIT:\n+\n+ * GIT_BINDIR\n+   Points where to find the git executable.  You should set it up to\n+   the place where the git binary was installed (usually /usr/bin) if you\n+   don't install git from sources together with gitweb.  [Default: $(bindir)]\n+ * GITWEB_SITENAME\n+   Shown in the title of all generated pages, defaults to the server name\n+   (SERVER_NAME CGI environment variable) if not set. [No default]\n+ * GITWEB_PROJECTROOT\n+   The root directory for all projects shown by gitweb. Must be set\n+   correctly for gitweb to find repositories to display.  See also\n+   \"Gitweb repositories\" in the INSTALL file for gitweb.  [Default: /pub/git]\n+ * GITWEB_PROJECT_MAXDEPTH\n+   The filesystem traversing limit for getting the project list; the number\n+   is taken as depth relative to the projectroot.  It is used when\n+   GITWEB_LIST is a directory (or is not set; then project root is used).\n+   This is meant to speed up project listing on large work trees by limiting\n+   search depth.  [Default: 2007]\n+ * GITWEB_LIST\n+   Points to a directory to scan for projects (defaults to project root\n+   if not set / if empty) or to a file with explicit listing of projects\n+   (together with projects' ownership). See \"Generating projects list\n+   using gitweb\" in INSTALL file for gitweb to find out how to generate\n+   such file from scan of a directory. [No default, which means use root\n+   directory for projects]\n+ * GITWEB_EXPORT_OK\n+   Show repository only if this file exists (in repository).  Only\n+   effective if this variable evaluates to true.  [No default / Not set]\n+ * GITWEB_STRICT_EXPORT\n+   Only allow viewing of repositories also shown on the overview page.\n+   This for example makes GITWEB_EXPORT_OK to decide if repository is\n+   available and not only if it is shown.  If GITWEB_LIST points to\n+   file with list of project, only those repositories listed would be\n+   available for gitweb.  [No default]\n+ * GITWEB_HOMETEXT\n+   Points to an .html file which is included on the gitweb project\n+   overview page ('projects_list' view), if it exists.  Relative to\n+   gitweb.cgi script.  [Default: indextext.html]\n+ * GITWEB_SITE_HEADER\n+   Filename of html text to include at top of each page.  Relative to\n+   gitweb.cgi script.  [No default]\n+ * GITWEB_SITE_FOOTER\n+   Filename of html text to include at bottom of each page.  Relative to\n+   gitweb.cgi script.  [No default]\n+ * GITWEB_HOME_LINK_STR\n+   String of the home link on top of all pages, leading to $home_link\n+   (usually main gitweb page, which means projects list).  Used as first\n+   part of gitweb view \"breadcrumb trail\": <home> / <project> / <view>.\n+   [Default: projects]\n+ * GITWEB_SITENAME\n+   Name of your site or organization to appear in page titles.  Set it\n+   to something descriptive for clearer bookmarks etc.  If not set\n+   (if empty) gitweb uses \"$SERVER_NAME Git\", or \"Untitled Git\" if\n+   SERVER_NAME CGI environment variable is not set (e.g. if running\n+   gitweb as standalone script).  [No default]\n+ * GITWEB_BASE_URL\n+   Git base URLs used for URL to where fetch project from, i.e. full\n+   URL is \"$git_base_url/$project\".  Shown on projects summary page.\n+   Repository URL for project can be also configured per repository; this\n+   takes precedence over URLs composed from base URL and a project name.\n+   Note that you can setup multiple base URLs (for example one for\n+   git:// protocol access, another for http:// access) from the gitweb\n+   config file.  [No default]\n+ * GITWEB_CSS\n+   Points to the location where you put gitweb.css on your web server\n+   (or to be more generic, the URI of gitweb stylesheet).  Relative to the\n+   base URI of gitweb.  Note that you can setup multiple stylesheets from\n+   the gitweb config file.  [Default: static/gitweb.css (or\n+   static/gitweb.min.css if the CSSMIN variable is defined / CSS minifier\n+   is used)]\n+ * GITWEB_LOGO\n+   Points to the location where you put git-logo.png on your web server\n+   (or to be more generic URI of logo, 72x27 size, displayed in top right\n+   corner of each gitweb page, and used as logo for Atom feed).  Relative\n+   to base URI of gitweb.  [Default: static/git-logo.png]\n+ * GITWEB_FAVICON\n+   Points to the location where you put git-favicon.png on your web server\n+   (or to be more generic URI of favicon, assumed to be image/png type;\n+   web browsers that support favicons (website icons) may display them\n+   in the browser's URL bar and next to site name in bookmarks).  Relative\n+   to base URI of gitweb.  [Default: static/git-favicon.png]\n+ * GITWEB_JS\n+   Points to the location where you put gitweb.js on your web server\n+   (or to be more generic URI of JavaScript code used by gitweb).\n+   Relative to base URI of gitweb.  [Default: static/gitweb.js (or\n+   static/gitweb.min.js if JSMIN build variable is defined / JavaScript\n+   minifier is used)]\n+ * GITWEB_CONFIG\n+   This Perl file will be loaded using 'do' and can be used to override any\n+   of the options above as well as some other options -- see the \"Runtime\n+   gitweb configuration\" section below, and top of 'gitweb.cgi' for their\n+   full list and description.  If the environment variable GITWEB_CONFIG\n+   is set when gitweb.cgi is executed, then the file specified in the\n+   environment variable will be loaded instead of the file specified\n+   when gitweb.cgi was created.  [Default: gitweb_config.perl]\n+ * GITWEB_CONFIG_SYSTEM\n+   This Perl file will be loaded using 'do' as a fallback if GITWEB_CONFIG\n+   does not exist.  If the environment variable GITWEB_CONFIG_SYSTEM is set\n+   when gitweb.cgi is executed, then the file specified in the environment\n+   variable will be loaded instead of the file specified when gitweb.cgi was\n+   created.  [Default: /etc/gitweb.conf]\n+ * HIGHLIGHT_BIN\n+   Path to the highlight executable to use (must be the one from\n+   http://www.andre-simon.de due to assumptions about parameters and output).\n+   Useful if highlight is not installed on your webserver's PATH.\n+   [Default: highlight]\n+\n Build example\n ~~~~~~~~~~~~~\n \ndiff --git a/gitweb/README b/gitweb/README\nindex a3a697b..a4cfcb4 100644\n--- a/gitweb/README\n+++ b/gitweb/README\n@@ -7,120 +7,6 @@ The one working on:\n From the git version 1.4.0 gitweb is bundled with git.\n \n \n-How to configure gitweb for your local system\n----------------------------------------------\n-\n-See also the \"Build time configuration\" section in the INSTALL\n-file for gitweb (in gitweb/INSTALL).\n-\n-You can specify the following configuration variables when building GIT:\n- * GIT_BINDIR\n-   Points where to find the git executable.  You should set it up to\n-   the place where the git binary was installed (usually /usr/bin) if you\n-   don't install git from sources together with gitweb.  [Default: $(bindir)]\n- * GITWEB_SITENAME\n-   Shown in the title of all generated pages, defaults to the server name\n-   (SERVER_NAME CGI environment variable) if not set. [No default]\n- * GITWEB_PROJECTROOT\n-   The root directory for all projects shown by gitweb. Must be set\n-   correctly for gitweb to find repositories to display.  See also\n-   \"Gitweb repositories\" in the INSTALL file for gitweb.  [Default: /pub/git]\n- * GITWEB_PROJECT_MAXDEPTH\n-   The filesystem traversing limit for getting the project list; the number\n-   is taken as depth relative to the projectroot.  It is used when\n-   GITWEB_LIST is a directory (or is not set; then project root is used).\n-   This is meant to speed up project listing on large work trees by limiting\n-   search depth.  [Default: 2007]\n- * GITWEB_LIST\n-   Points to a directory to scan for projects (defaults to project root\n-   if not set / if empty) or to a file with explicit listing of projects\n-   (together with projects' ownership). See \"Generating projects list\n-   using gitweb\" in INSTALL file for gitweb to find out how to generate\n-   such file from scan of a directory. [No default, which means use root\n-   directory for projects]\n- * GITWEB_EXPORT_OK\n-   Show repository only if this file exists (in repository).  Only\n-   effective if this variable evaluates to true.  [No default / Not set]\n- * GITWEB_STRICT_EXPORT\n-   Only allow viewing of repositories also shown on the overview page.\n-   This for example makes GITWEB_EXPORT_OK to decide if repository is\n-   available and not only if it is shown.  If GITWEB_LIST points to\n-   file with list of project, only those repositories listed would be\n-   available for gitweb.  [No default]\n- * GITWEB_HOMETEXT\n-   Points to an .html file which is included on the gitweb project\n-   overview page ('projects_list' view), if it exists.  Relative to\n-   gitweb.cgi script.  [Default: indextext.html]\n- * GITWEB_SITE_HEADER\n-   Filename of html text to include at top of each page.  Relative to\n-   gitweb.cgi script.  [No default]\n- * GITWEB_SITE_FOOTER\n-   Filename of html text to include at bottom of each page.  Relative to\n-   gitweb.cgi script.  [No default]\n- * GITWEB_HOME_LINK_STR\n-   String of the home link on top of all pages, leading to $home_link\n-   (usually main gitweb page, which means projects list).  Used as first\n-   part of gitweb view \"breadcrumb trail\": <home> / <project> / <view>.\n-   [Default: projects]\n- * GITWEB_SITENAME\n-   Name of your site or organization to appear in page titles.  Set it\n-   to something descriptive for clearer bookmarks etc.  If not set\n-   (if empty) gitweb uses \"$SERVER_NAME Git\", or \"Untitled Git\" if\n-   SERVER_NAME CGI environment variable is not set (e.g. if running\n-   gitweb as standalone script).  [No default]\n- * GITWEB_BASE_URL\n-   Git base URLs used for URL to where fetch project from, i.e. full\n-   URL is \"$git_base_url/$project\".  Shown on projects summary page.\n-   Repository URL for project can be also configured per repository; this\n-   takes precedence over URLs composed from base URL and a project name.\n-   Note that you can setup multiple base URLs (for example one for\n-   git:// protocol access, another for http:// access) from the gitweb\n-   config file.  [No default]\n- * GITWEB_CSS\n-   Points to the location where you put gitweb.css on your web server\n-   (or to be more generic, the URI of gitweb stylesheet).  Relative to the\n-   base URI of gitweb.  Note that you can setup multiple stylesheets from\n-   the gitweb config file.  [Default: static/gitweb.css (or\n-   static/gitweb.min.css if the CSSMIN variable is defined / CSS minifier\n-   is used)]\n- * GITWEB_LOGO\n-   Points to the location where you put git-logo.png on your web server\n-   (or to be more generic URI of logo, 72x27 size, displayed in top right\n-   corner of each gitweb page, and used as logo for Atom feed).  Relative\n-   to base URI of gitweb.  [Default: static/git-logo.png]\n- * GITWEB_FAVICON\n-   Points to the location where you put git-favicon.png on your web server\n-   (or to be more generic URI of favicon, assumed to be image/png type;\n-   web browsers that support favicons (website icons) may display them\n-   in the browser's URL bar and next to site name in bookmarks).  Relative\n-   to base URI of gitweb.  [Default: static/git-favicon.png]\n- * GITWEB_JS\n-   Points to the location where you put gitweb.js on your web server\n-   (or to be more generic URI of JavaScript code used by gitweb).\n-   Relative to base URI of gitweb.  [Default: static/gitweb.js (or\n-   static/gitweb.min.js if JSMIN build variable is defined / JavaScript\n-   minifier is used)]\n- * GITWEB_CONFIG\n-   This Perl file will be loaded using 'do' and can be used to override any\n-   of the options above as well as some other options -- see the \"Runtime\n-   gitweb configuration\" section below, and top of 'gitweb.cgi' for their\n-   full list and description.  If the environment variable GITWEB_CONFIG\n-   is set when gitweb.cgi is executed, then the file specified in the\n-   environment variable will be loaded instead of the file specified\n-   when gitweb.cgi was created.  [Default: gitweb_config.perl]\n- * GITWEB_CONFIG_SYSTEM\n-   This Perl file will be loaded using 'do' as a fallback if GITWEB_CONFIG\n-   does not exist.  If the environment variable GITWEB_CONFIG_SYSTEM is set\n-   when gitweb.cgi is executed, then the file specified in the environment\n-   variable will be loaded instead of the file specified when gitweb.cgi was\n-   created.  [Default: /etc/gitweb.conf]\n- * HIGHLIGHT_BIN\n-   Path to the highlight executable to use (must be the one from\n-   http://www.andre-simon.de due to assumptions about parameters and output).\n-   Useful if highlight is not installed on your webserver's PATH.\n-   [Default: highlight]\n-\n-\n Runtime gitweb configuration\n ----------------------------\n \n-- \n1.7.5\n"},{"id":"169201","messageId":"1307026553-1181-3-git-send-email-jnareb@gmail.com","threadId":"27536","inReplyTo":"1307026553-1181-1-git-send-email-jnareb@gmail.com","subject":"[PATCH 2/2] gitweb: Describe CSSMIN and JSMIN in gitweb/INSTALL","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2011-06-02T14:55:53Z","receivedAt":"2011-06-02T14:55:53Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"The build-time configuration variables JSMIN and CSSMIN were mentioned\nonly in Makefile; add their description to gitweb/INSTALL.\n\nThis required moving description of GITWEB_JS up, near GITWEB_CSS and\njust introduced CSMIN and JSMIN.\n\nSigned-off-by: Jakub Narebski <jnareb@gmail.com>\n---\n gitweb/INSTALL |   19 +++++++++++++------\n 1 files changed, 13 insertions(+), 6 deletions(-)\n\ndiff --git a/gitweb/INSTALL b/gitweb/INSTALL\nindex 32a52b7..2346aad 100644\n--- a/gitweb/INSTALL\n+++ b/gitweb/INSTALL\n@@ -147,6 +147,19 @@ You can specify the following configuration variables when building GIT:\n    the gitweb config file.  [Default: static/gitweb.css (or\n    static/gitweb.min.css if the CSSMIN variable is defined / CSS minifier\n    is used)]\n+ * GITWEB_JS\n+   Points to the location where you put gitweb.js on your web server\n+   (or to be more generic URI of JavaScript code used by gitweb).\n+   Relative to base URI of gitweb.  [Default: static/gitweb.js (or\n+   static/gitweb.min.js if JSMIN build variable is defined / JavaScript\n+   minifier is used)]\n+ * CSSMIN, JSMIN\n+   Invocation of a CSS minifier or a JavaScript minifier, respectively,\n+   working as a filter (source on standard input, minified result on\n+   standard output).  If set, it is used to generate a minified version of\n+   'static/gitweb.css' or 'static/gitweb.js', respectively.  *Note* that\n+   minified files would have *.min.css and *.min.js extension, which is\n+   important if you also set GITWEB_CSS and/or GITWEB_JS.  [No default]\n  * GITWEB_LOGO\n    Points to the location where you put git-logo.png on your web server\n    (or to be more generic URI of logo, 72x27 size, displayed in top right\n@@ -158,12 +171,6 @@ You can specify the following configuration variables when building GIT:\n    web browsers that support favicons (website icons) may display them\n    in the browser's URL bar and next to site name in bookmarks).  Relative\n    to base URI of gitweb.  [Default: static/git-favicon.png]\n- * GITWEB_JS\n-   Points to the location where you put gitweb.js on your web server\n-   (or to be more generic URI of JavaScript code used by gitweb).\n-   Relative to base URI of gitweb.  [Default: static/gitweb.js (or\n-   static/gitweb.min.js if JSMIN build variable is defined / JavaScript\n-   minifier is used)]\n  * GITWEB_CONFIG\n    This Perl file will be loaded using 'do' and can be used to override any\n    of the options above as well as some other options -- see the \"Runtime\n-- \n1.7.5\n"},{"id":"169211","messageId":"7vtyc8ccy6.fsf@alter.siamese.dyndns.org","threadId":"27536","inReplyTo":"1307026553-1181-2-git-send-email-jnareb@gmail.com","subject":"Re: [PATCH 1/2] gitweb: Move information about installation from README to INSTALL","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-06-02T18:20:33Z","receivedAt":"2011-06-02T18:20:33Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jakub Narebski <jnareb@gmail.com> writes:\n\n> Almost straightformard moving of \"How to configure gitweb for your\n> local system\" section from gitweb/README to gitweb/INSTALL, as it is\n> about build time configuration.  Updated references to it.\n>\n> Signed-off-by: Jakub Narebski <jnareb@gmail.com>\n> ---\n>  gitweb/INSTALL |  115 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-\n>  gitweb/README  |  114 -------------------------------------------------------\n>  2 files changed, 113 insertions(+), 116 deletions(-)\n\nLooks good.  Thanks.\n\n\"git blame\" tip of the day. After applying a series like this on a topic\nbranch, running\n\n $ git blame -C master.. -- gitweb/INSTALL | grep -C 3 -e '^[^^]' | less -S\n\nlets us view the lines without drowning in the bulk of lines that were\nmerely moved.\n"},{"id":"169214","messageId":"BANLkTindofLtdgQpVTjH-9ZsceAiW6qH7Q@mail.gmail.com","threadId":"27536","inReplyTo":"1307026553-1181-2-git-send-email-jnareb@gmail.com","subject":"Re: [PATCH 1/2] gitweb: Move information about installation from README to INSTALL","fromName":"Øyvind A. Holm","fromEmail":"sunny@sunbase.org","sentAt":"2011-06-02T18:31:35Z","receivedAt":"2011-06-02T18:31:35Z","isPatch":true,"sender":{"key":"sunny@sunbase.org","avatar":"https://avatars.githubusercontent.com/u/113445?v=4"},"body":"On 2 June 2011 16:55, Jakub Narebski <jnareb@gmail.com> wrote:\n> Almost straightformard moving of \"How to configure gitweb for your\n\ns/straightformard/straightforward/\n\nRegards,\nØyvind\n"},{"id":"169260","messageId":"201106031831.50496.jnareb@gmail.com","threadId":"27536","inReplyTo":"1307026553-1181-1-git-send-email-jnareb@gmail.com","subject":"[PATCH 2/3] gitweb: Move \"Requirements\" up in gitweb/INSTALL","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2011-06-03T16:31:48Z","receivedAt":"2011-06-03T16:31:48Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"This way you can examine prerequisites at first glance, before\ndetailed instructions on installing gitweb.  Straightforward\ntext movement.\n\nSigned-off-by: Jakub Narebski <jnareb@gmail.com>\n---\nThis is another fall off from my work on continuing Drew Northup and\nmine work of adding gitweb.conf(5) and gitweb(1) manpages (moving\ngitweb documentation to manpages).\n\n gitweb/INSTALL |   30 +++++++++++++++---------------\n 1 files changed, 15 insertions(+), 15 deletions(-)\n\ndiff --git a/gitweb/INSTALL b/gitweb/INSTALL\nindex 2346aad..c5236fe 100644\n--- a/gitweb/INSTALL\n+++ b/gitweb/INSTALL\n@@ -25,6 +25,21 @@ The above example assumes that your web server is configured to run\n scripts).\n \n \n+Requirements\n+------------\n+\n+ - Core git tools\n+ - Perl\n+ - Perl modules: CGI, Encode, Fcntl, File::Find, File::Basename.\n+ - web server\n+\n+The following optional Perl modules are required for extra features\n+ - Digest::MD5 - for gravatar support\n+ - CGI::Fast and FCGI - for running gitweb as FastCGI script\n+ - HTML::TagCloud - for fancy tag cloud in project list view\n+ - HTTP::Date or Time::ParseDate - to support If-Modified-Since for feeds\n+\n+\n Build time configuration\n ------------------------\n \n@@ -347,21 +362,6 @@ $projects_list variable in gitweb config):\n \tperl -- /var/www/cgi-bin/gitweb.cgi\n \n \n-Requirements\n-------------\n-\n- - Core git tools\n- - Perl\n- - Perl modules: CGI, Encode, Fcntl, File::Find, File::Basename.\n- - web server\n-\n-The following optional Perl modules are required for extra features\n- - Digest::MD5 - for gravatar support\n- - CGI::Fast and FCGI - for running gitweb as FastCGI script\n- - HTML::TagCloud - for fancy tag cloud in project list view\n- - HTTP::Date or Time::ParseDate - to support If-Modified-Since for feeds\n-\n-\n Example web server configuration\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-- \n1.7.5\n"}]}