scan-tree: Unify gitweb.* and cgit.* settings into one config option.

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index d1a90c5a8c5088d05269ed9ba48a8b56f2caa69e..278de90cfb5c6aba55d409b2d635abe653725384 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -70,6 +70,10 @@ cache-static-ttl::
        version of repository pages accessed with a fixed SHA1. Default value:
        "5".
 
+case-sensitive-sort::
+       Sort items in the repo list case sensitively. Default value: "1".
+       See also: repository-sort.
+
 clone-prefix::
        Space-separated list of common prefixes which, when combined with a
        repository url, generates valid clone urls for the repository. This
@@ -106,24 +110,6 @@ 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.
-       Default value: "1". See also: scan-path.
-
-enable-gitweb-section::
-       If set to "1" and scan-path is enabled, we first check each repository
-       for the git config value "gitweb.category" to determine the repository's
-       section. This value is overridden if section-from-path is enabled.
-       Default value: "1". See also: scan-path section-from-path.
-
 enable-http-clone::
        If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
        If you use an alternate way of serving git repositories, you may wish
@@ -159,6 +145,15 @@ 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".
 
+enable-git-config::
+       Flag which, when set to "1", will allow cgit to use git config to set
+       any repo specific settings. This option is used in conjunction with
+       "scan-path" to augment _repo._ settings. The keys gitweb.owner,
+       gitweb.category, and gitweb.description will map to the cgit keys
+       repo.owner, repo.section, and repo.desc, respectivly. All git config
+       keys that begin with "cgit." will be mapped to the corresponding "repo."
+       key in cgit. Default value: "0". See also: scan-path section-from-path.
+
 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
@@ -333,11 +328,17 @@ section::
        after this option will inherit the current section name. Default value:
        none.
 
+repository-sort::
+       The way in which repositories in each section are sorted. Valid values
+       are "name" for sorting by the repo name or "age" for sorting by the
+       most recently updated repository. Default value: "name". See also:
+       section, case-sensitive-sort.
+
 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.
+       above the repo directory. Default value: "0".
 
 side-by-side-diffs::
        If set to "1" shows side-by-side diffs instead of unidiffs per
@@ -384,6 +385,7 @@ virtual-root::
        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::