Add support for 'project-list' option

This option specifies the location of a projectlist file as used by
gitweb - when 'scan-tree' is later specified, only the projects listed in
the projectlist file will be added.

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

1 files changed, 9 insertions, 1 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index a853522..ec004d4 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -179,126 +179,134 @@ max-atom-items::
 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".
 
+project-list::
+        A list of subdirectories inside of scan-path, relative to it, that
+        should loaded as git repositories. This must be defined prior to
+        scan-path. Default value: none. See also: scan-path.
+
 renamelimit::
         Maximum number of files to consider when detecting renames. The value
          "-1" uses the compiletime value in git (for further info, look at
           `man git-diff`). Default value: "-1".
 
 repo.group::
         Legacy alias for "section". This option is deprecated and will not be
         supported in cgit-1.0.
 
 robots::
         Text used as content for the "robots" meta-tag. Default value:
         "index, nofollow".
 
 root-desc::
         Text printed below the heading on the repository index page. Default
         value: "a fast webinterface for the git dscm".
 
 root-readme::
         The content of the file specified with this option will be included
         verbatim below the "about" link on the repository index page. Default
         value: none.
 
 root-title::
         Text printed as heading on the repository index page. Default value:
         "Git Repository Browser".
 
 scan-path::
         A path which will be scanned for repositories. If caching is enabled,
         the result will be cached as a cgitrc include-file in the cache
-        directory. Default value: none. See also: cache-scanrc-ttl.
+        directory. If project-list has been defined prior to scan-path,
+        scan-path loads only the directories listed in the file pointed to by
+        project-list. Default value: none. See also: cache-scanrc-ttl,
+        project-list.
 
 section::
         The name of the current repository section - all repositories defined
         after this option will inherit the current section name. Default value:
         none.
 
 side-by-side-diffs::
         If set to "1" shows side-by-side diffs instead of unidiffs per
         default. Default value: "0".
 
 snapshots::
         Text which specifies the default set of snapshot formats generated by
         cgit. The value is a space-separated list of zero or more of the
         values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
 
 source-filter::
         Specifies a command which will be invoked to format plaintext blobs
         in the tree view. The command will get the blob content on its STDIN
         and the name of the blob as its only command line argument. The STDOUT
         from the command will be included verbatim as the blob contents, i.e.
         this can be used to implement e.g. syntax highlighting. Default value:
         none.
 
 summary-branches::
         Specifies the number of branches to display in the repository "summary"
         view. Default value: "10".
 
 summary-log::
         Specifies the number of log entries to display in the repository
         "summary" view. Default value: "10".
 
 summary-tags::
         Specifies the number of tags to display in the repository "summary"
         view. Default value: "10".
 
 virtual-root::
         Url which, if specified, will be used as root for all cgit links. It
         will also cause cgit to generate 'virtual urls', i.e. urls like
         '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
         value: none.
         NOTE: cgit has recently learned how to use PATH_INFO to achieve the
         same kind of virtual urls, so this option will probably be deprecated.
 
 REPOSITORY SETTINGS
 -------------------
 repo.about-filter::
         Override the default about-filter. Default value: none. See also:
         "enable-filter-overrides".