cgitrc.5.txt: document repo.module-link

The global module-link option can be overridden per repo, but this has
never been documented.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>

1 files changed, 6 insertions, 0 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 10b86f3..26c4bfc 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -211,384 +211,390 @@ max-stats::
         "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, "MACRO
         EXPANSION".
 
 readme::
         Text which will be used as default value for "repo.readme". Default
         value: none.
 
 remove-suffix::
         If set to "1" and scan-path is enabled, if any repositories are found
         with a suffix of ".git", this suffix will be removed for the url and
         name. Default value: "0". 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-hidden-path::
         If set to "1" and scan-path is enabled, scan-path will recurse into
         directories whose name starts with a period ('.'). Otherwise,
         scan-path will stay away from such directories (considered as
         "hidden"). Note that this does not apply to the ".git" directory in
         non-bare repos. This must be defined prior to scan-path.
         Default value: 0. See also: scan-path.
 
 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. 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. Be advised that only the global settings taken
         before the scan-path directive will be applied to each repository.
         Default value: none. See also: cache-scanrc-ttl, project-list,
         "MACRO EXPANSION".
 
 section::
         The name of the current repository section - all repositories defined
         after this option will inherit the current section name. Default value:
         none.
 
 section-from-path::
         A number which, if specified before scan-path, specifies how many
         path elements from each repo path to use as a default section name.
         If negative, cgit will discard the specified number of path elements
         above the repo directory. Default value: 0.
 
 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", "tar.xz" 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".
 
 strict-export::
         Filename which, if specified, needs to be present within the repository
         for cgit to allow access to that repository. This can be used to emulate
         gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
         repositories to match those exported by git-daemon. This option MUST come
         before 'scan-path'.
 
 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".
 
 repo.clone-url::
         A list of space-separated urls which can be used to clone this repo.
         Default value: none.
 
 repo.commit-filter::
         Override the default commit-filter. Default value: none. See also:
         "enable-filter-overrides".
 
 repo.defbranch::
         The name of the default branch for this repository. If no such branch
         exists in the repository, the first branch name (when sorted) is used
         as default instead. Default value: "master".
 
 repo.desc::
         The value to show as repository description. Default value: none.
 
 repo.enable-commit-graph::
         A flag which can be used to disable the global setting
         `enable-commit-graph'. Default value: none.
 
 repo.enable-log-filecount::
         A flag which can be used to disable the global setting
         `enable-log-filecount'. Default value: none.
 
 repo.enable-log-linecount::
         A flag which can be used to disable the global setting
         `enable-log-linecount'. Default value: none.
 
 repo.enable-remote-branches::
         Flag which, when set to "1", will make cgit display remote branches
         in the summary and refs views. Default value: <enable-remote-branches>.
 
 repo.enable-subject-links::
         A flag which can be used to override the global setting
         `enable-subject-links'. Default value: none.
 
 repo.logo::
         Url which specifies the source of an image which will be used as a logo
         on this repo's pages. Default value: global logo.
 
 repo.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: global logo-link.
 
+repo.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: <module-link>
+
 repo.max-stats::
         Override the default maximum statistics period. Valid values are equal
         to the values specified for the global "max-stats" setting. Default
         value: none.
 
 repo.name::
         The value to show as repository name. Default value: <repo.url>.
 
 repo.owner::
         A value used to identify the owner of the repository. Default value:
         none.
 
 repo.path::
         An absolute path to the repository directory. For non-bare repositories
         this is the .git-directory. Default value: none.
 
 repo.readme::
         A path (relative to <repo.path>) which specifies a file to include
         verbatim as the "About" page for this repo. You may also specify a
         git refspec by head or by hash by prepending the refspec followed by
         a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
 
 repo.snapshots::
         A mask of allowed snapshot-formats for this repo, restricted by the
         "snapshots" global setting. Default value: <snapshots>.
 
 repo.section::
         Override the current section name for this repository. Default value:
         none.
 
 repo.source-filter::
         Override the default source-filter. Default value: none. See also:
         "enable-filter-overrides".
 
 repo.url::
         The relative url used to access the repository. This must be the first
         setting specified for each repo. Default value: none.
 
 
 REPOSITORY-SPECIFIC CGITRC FILE
 -------------------------------
 When the option "scan-path" is used to auto-discover git repositories, cgit
 will try to parse the file "cgitrc" within any found repository. Such a
 repo-specific config file may contain any of the repo-specific options
 described above, except "repo.url" and "repo.path". Additionally, the "filter"
 options are only acknowledged in repo-specific config files when
 "enable-filter-overrides" is set to "1".
 
 Note: the "repo." prefix is dropped from the option names in repo-specific
 config files, e.g. "repo.desc" becomes "desc".
 
 
 MACRO EXPANSION
 ---------------
 The following cgitrc options supports a simple macro expansion feature,
 where tokens prefixed with "$" are replaced with the value of a similary
 named environment variable:
 
 - cache-root
 - include
 - project-list
 - scan-path
 
 Macro expansion will also happen on the content of $CGIT_CONFIG, if
 defined.
 
 One usage of this feature is virtual hosting, which in its simplest form
 can be accomplished by adding the following line to /etc/cgitrc:
 
         include=/etc/cgitrc.d/$HTTP_HOST
 
 
 EXAMPLE CGITRC FILE
 -------------------
 
 ....
 # Enable caching of up to 1000 output entriess
 cache-size=1000
 
 
 # Specify some default clone prefixes
 clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
 
 # Specify the css url
 css=/css/cgit.css
 
 
 # Show extra links for each repository on the index page
 enable-index-links=1
 
 
 # Enable ASCII art commit history graph on the log pages
 enable-commit-graph=1
 
 
 # Show number of affected files per commit on the log pages
 enable-log-filecount=1
 
 
 # Show number of added/removed lines per commit on the log pages
 enable-log-linecount=1
 
 
 # Add a cgit favicon
 favicon=/favicon.ico
 
 
 # Use a custom logo
 logo=/img/mylogo.png
 
 
 # Enable statistics per week, month and quarter
 max-stats=quarter
 
 
 # Set the title and heading of the repository index page
 root-title=example.com git repositories
 
 
 # Set a subheading for the repository index page
 root-desc=tracking the foobar development
 
 
 # Include some more info about example.com on the index page
 root-readme=/var/www/htdocs/about.html
 
 
 # Allow download of tar.gz, tar.bz2 and zip-files
 snapshots=tar.gz tar.bz2 zip
 
 
 ##
 ## List of common mimetypes
 ##
 
 mimetype.gif=image/gif
 mimetype.html=text/html
 mimetype.jpg=image/jpeg
 mimetype.jpeg=image/jpeg
 mimetype.pdf=application/pdf
 mimetype.png=image/png
 mimetype.svg=image/svg+xml
 
 
 ##
 ## List of repositories.
 ## PS: Any repositories listed when section is unset will not be
 ##     displayed under a section heading
 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 ##      and included like this:
 ##        include=/etc/cgitrepos
 ##
 
 
 repo.url=foo
 repo.path=/pub/git/foo.git
 repo.desc=the master foo repository
 repo.owner=fooman@example.com
 repo.readme=info/web/about.html
 
 
 repo.url=bar
 repo.path=/pub/git/bar.git
 repo.desc=the bars for your foo
 repo.owner=barman@example.com
 repo.readme=info/web/about.html
 
 
 # The next repositories will be displayed under the 'extras' heading
 section=extras
 
 
 repo.url=baz
 repo.path=/pub/git/baz.git
 repo.desc=a set of extensions for bar users
 
 repo.url=wiz
 repo.path=/pub/git/wiz.git
 repo.desc=the wizard of foo
 
 
 # Add some mirrored repositories
 section=mirrors
 
 
 repo.url=git
 repo.path=/pub/git/git.git
 repo.desc=the dscm
 
 
 repo.url=linux
 repo.path=/pub/git/linux.git