Add support for 'enable-gitweb-owner' option

When this option is enabled (which it is by default), cgit will lookup
the 'gitweb.owner' setting in each git config file found when processing
the 'scan-path' option.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>

1 files changed, 5 insertions, 0 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 6fb1083..5d77973 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,225 +1,230 @@
 :man source:   cgit
 :man manual:   cgit
 
 CGITRC(5)
 ========
 
 
 NAME
 ----
 cgitrc - runtime configuration for cgit
 
 
 SYNOPSIS
 --------
 Cgitrc contains all runtime settings for cgit, including the list of git
 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 
 LOCATION
 --------
 The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
 runtime, cgit will consult the environment variable CGIT_CONFIG and, if
 defined, use its value instead.
 
 
 GLOBAL SETTINGS
 ---------------
 about-filter::
         Specifies a command which will be invoked to format the content of
         about pages (both top-level and for each repository). The command will
         get the content of the about-file on its STDIN, and the STDOUT from the
         command will be included verbatim on the about page. Default value:
         none.
 
 agefile::
         Specifies a path, relative to each repository path, which can be used
         to specify the date and time of the youngest commit in the repository.
         The first line in the file is used as input to the "parse_date"
         function in libgit. Recommended timestamp-format is "yyyy-mm-dd
         hh:mm:ss". Default value: "info/web/last-modified".
 
 cache-root::
         Path used to store the cgit cache entries. Default value:
         "/var/cache/cgit".
 
 cache-dynamic-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of repository pages accessed without a fixed SHA1. Default
         value: "5".
 
 cache-repo-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of the repository summary page. Default value: "5".
 
 cache-root-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of the repository index page. Default value: "5".
 
 cache-scanrc-ttl::
         Number which specifies the time-to-live, in minutes, for the result
         of scanning a path for git repositories. Default value: "15".
 
 cache-size::
         The maximum number of entries in the cgit cache. Default value: "0"
         (i.e. caching is disabled).
 
 cache-static-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of repository pages accessed with a fixed SHA1. Default value:
         "5".
 
 clone-prefix::
         Space-separated list of common prefixes which, when combined with a
         repository url, generates valid clone urls for the repository. This
         setting is only used if `repo.clone-url` is unspecified. Default value:
         none.
 
 commit-filter::
         Specifies a command which will be invoked to format commit messages.
         The command will get the message on its STDIN, and the STDOUT from the
         command will be included verbatim as the commit message, i.e. this can
         be used to implement bugtracker integration. Default value: none.
 
 css::
         Url which specifies the css document to include in all cgit pages.
         Default value: "/cgit.css".
 
 embedded::
         Flag which, when set to "1", will make cgit generate a html fragment
         suitable for embedding in other html pages. Default value: none. See
         also: "noheader".
         
 enable-filter-overrides::
         Flag which, when set to "1", allows all filter settings to be
         overridden in repository-specific cgitrc files. Default value: none.
 
+enable-gitweb-owner::
+        If set to "1" and scan-path is enabled, we first check each repository
+        for the git config value "gitweb.owner" to determine the owner.
+        Default value: "1". See also: scan-path.
+
 enable-index-links::
         Flag which, when set to "1", will make cgit generate extra links for
         each repo in the repository index (specifically, to the "summary",
         "commit" and "tree" pages). Default value: "0".
 
 enable-log-filecount::
         Flag which, when set to "1", will make cgit print the number of
         modified files for each commit on the repository log page. Default
         value: "0".
 
 enable-log-linecount::
         Flag which, when set to "1", will make cgit print the number of added
         and removed lines for each commit on the repository log page. Default
         value: "0".
 
 enable-remote-branches::
         Flag which, when set to "1", will make cgit display remote branches
         in the summary and refs views. Default value: "0". See also:
         "repo.enable-remote-branches".
 
 enable-subject-links::
         Flag which, when set to "1", will make cgit use the subject of the
         parent commit as link text when generating links to parent commits
         in commit view. Default value: "0". See also:
         "repo.enable-subject-links".
 
 enable-tree-linenumbers::
         Flag which, when set to "1", will make cgit generate linenumber links
         for plaintext blobs printed in the tree view. Default value: "1".
 
 favicon::
         Url used as link to a shortcut icon for cgit. If specified, it is
         suggested to use the value "/favicon.ico" since certain browsers will
         ignore other values. Default value: none.
 
 footer::
         The content of the file specified with this option will be included
         verbatim at the bottom of all pages (i.e. it replaces the standard
         "generated by..." message. Default value: none.
 
 head-include::
         The content of the file specified with this option will be included
         verbatim in the html HEAD section on all pages. Default value: none.
 
 header::
         The content of the file specified with this option will be included
         verbatim at the top of all pages. Default value: none.
 
 include::
         Name of a configfile to include before the rest of the current config-
         file is parsed. Default value: none.
 
 index-header::
         The content of the file specified with this option will be included
         verbatim above the repository index. This setting is deprecated, and
         will not be supported by cgit-1.0 (use root-readme instead). Default
         value: none.
 
 index-info::
         The content of the file specified with this option will be included
         verbatim below the heading on the repository index page. This setting
         is deprecated, and will not be supported by cgit-1.0 (use root-desc
         instead). Default value: none.
 
 local-time::
         Flag which, if set to "1", makes cgit print commit and tag times in the
         servers timezone. Default value: "0".
 
 logo::
         Url which specifies the source of an image which will be used as a logo
         on all cgit pages. Default value: "/cgit.png".
 
 logo-link::
         Url loaded when clicking on the cgit logo image. If unspecified the
         calculated url of the repository index page will be used. Default
         value: none.
 
 max-atom-items::
         Specifies the number of items to display in atom feeds view. Default
         value: "10".
 
 max-commit-count::
         Specifies the number of entries to list per page in "log" view. Default
         value: "50".
 
 max-message-length::
         Specifies the maximum number of commit message characters to display in
         "log" view. Default value: "80".
 
 max-repo-count::
                 Specifies the number of entries to list per page on therepository
         index page. Default value: "50".
 
 max-repodesc-length::
         Specifies the maximum number of repo description characters to display
         on the repository index page. Default value: "80".
 
 max-blob-size::
         Specifies the maximum size of a blob to display HTML for in KBytes.
         Default value: "0" (limit disabled).
 
 max-stats::
         Set the default maximum statistics period. Valid values are "week",
         "month", "quarter" and "year". If unspecified, statistics are
         disabled. Default value: none. See also: "repo.max-stats".
 
 mimetype.<ext>::
         Set the mimetype for the specified filename extension. This is used
         by the `plain` command when returning blob content.
 
 module-link::
         Text which will be used as the formatstring for a hyperlink when a
         submodule is printed in a directory listing. The arguments for the
         formatstring are the path and SHA1 of the submodule commit. Default
         value: "./?repo=%s&page=commit&id=%s"
 
 nocache::
         If set to the value "1" caching will be disabled. This settings is
         deprecated, and will not be honored starting with cgit-1.0. Default
         value: "0".
 
 noplainemail::
         If set to "1" showing full author email adresses will be disabled.
         Default value: "0".
 
 noheader::
         Flag which, when set to "1", will make cgit omit the standard header
         on all pages. Default value: none. See also: "embedded".