scan-tree: Support gitweb.description.

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 22a0dc3beedcad637f7f71ad7bbe2bfd459eaa55..86a19a93ccf6b80fc0ebbb49e842e55d780b7531 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -106,6 +106,13 @@ 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-desc::
+       If set to "1" and scan-path is enabled, we first check each repository
+       for the git config value "gitweb.description" to determine the owner.
+       Otherwise, the description is read from a file titled "description"
+       inside of the repository directory.
+       Default value: "1". See also: scan-path.
+
 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.
@@ -241,7 +248,7 @@ 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"
+       value: none.
 
 nocache::
        If set to the value "1" caching will be disabled. This settings is
@@ -388,7 +395,8 @@ repo.commit-filter::
 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".
+       as default instead. Default value: branch pointed to by HEAD, or
+       "master" if there is no suitable HEAD.
 
 repo.desc::
        The value to show as repository description. Default value: none.
@@ -428,6 +436,12 @@ repo.module-link::
        formatstring are the path and SHA1 of the submodule commit. Default
        value: <module-link>
 
+repo.module-link.<path>::
+       Text which will be used as the formatstring for a hyperlink when a
+       submodule with the specified subdirectory path is printed in a
+       directory listing. The only argument for the formatstring is the SHA1
+       of the submodule commit. Default value: none.
+
 repo.max-stats::
        Override the default maximum statistics period. Valid values are equal
        to the values specified for the global "max-stats" setting. Default
@@ -511,7 +525,7 @@ Also, all filters are handed the following environment variables:
 
 If a setting is not defined for a repository and the corresponding global
 setting is also not defined (if applicable), then the corresponding
-environment variable will be an empty string.
+environment variable will be unset.
 
 
 MACRO EXPANSION