Add branch-sort and repo.branch-sort options.

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 278de90cfb5c6aba55d409b2d635abe653725384..39b031eacaa56337508c9f4ab84cb1fd12fb356b 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -40,6 +40,11 @@ agefile::
        function in libgit. Recommended timestamp-format is "yyyy-mm-dd
        hh:mm:ss". Default value: "info/web/last-modified".
 
        function in libgit. Recommended timestamp-format is "yyyy-mm-dd
        hh:mm:ss". Default value: "info/web/last-modified".
 

+branch-sort::
+       Flag which, when set to "age", enables date ordering in the branch ref
+       list, and when set to "name" enables ordering by branch name. Default
+       value: "name".
+

 cache-root::
        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit". See also: "MACRO EXPANSION".
 cache-root::
        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit". See also: "MACRO EXPANSION".


@@ -72,7 +77,7 @@ cache-static-ttl::
 
 case-sensitive-sort::
        Sort items in the repo list case sensitively. Default value: "1".
 
 case-sensitive-sort::
        Sort items in the repo list case sensitively. Default value: "1".

-       See also: repository-sort.
+       See also: repository-sort, section-sort.

 
 clone-prefix::
        Space-separated list of common prefixes which, when combined with a
 
 clone-prefix::
        Space-separated list of common prefixes which, when combined with a


@@ -92,6 +97,12 @@ commit-filter::
        be used to implement bugtracker integration. Default value: none.
        See also: "FILTER API".
 
        be used to implement bugtracker integration. Default value: none.
        See also: "FILTER API".
 

+commit-sort::
+       Flag which, when set to "date", enables strict date ordering in the
+       commit log, and when set to "topo" enables strict topological
+       ordering. If unset, the default ordering of "git log" is used. Default
+       value: unset.
+

 css::
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
 css::
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".


@@ -120,6 +131,10 @@ enable-index-links::
        each repo in the repository index (specifically, to the "summary",
        "commit" and "tree" pages). Default value: "0".
 
        each repo in the repository index (specifically, to the "summary",
        "commit" and "tree" pages). Default value: "0".
 

+enable-index-owner::
+       Flag which, when set to "1", will make cgit display the owner of
+       each repo in the repository index. Default value: "1".
+

 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
 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


@@ -148,11 +163,11 @@ enable-tree-linenumbers::
 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
 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,
+       "scan-path" to augment repo-specific 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."
        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.
+       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
 
 favicon::
        Url used as link to a shortcut icon for cgit. If specified, it is


@@ -238,12 +253,13 @@ mimetype-file::
        Specifies the file to use for automatic mimetype lookup. If specified
        then this field is used as a fallback when no "mimetype.<ext>" match is
        found. If unspecified then no such lookup is performed. The typical file
        Specifies the file to use for automatic mimetype lookup. If specified
        then this field is used as a fallback when no "mimetype.<ext>" match is
        found. If unspecified then no such lookup is performed. The typical file

-       to use on a Linux system is /etc/mime.types. Default value: none. See
-       also: "mimetype.<ext>". The format of the file must comply to:
+       to use on a Linux system is /etc/mime.types. The format of the file must
+       comply to:

        - a comment line is an empty line or a line starting with a hash (#),
          optionally preceded by whitespace
        - a non-comment line starts with the mimetype (like image/png), followed
          by one or more file extensions (like jpg), all separated by whitespace
        - a comment line is an empty line or a line starting with a hash (#),
          optionally preceded by whitespace
        - a non-comment line starts with the mimetype (like image/png), followed
          by one or more file extensions (like jpg), all separated by whitespace

+       Default value: none. See also: "mimetype.<ext>".

 
 module-link::
        Text which will be used as the formatstring for a hyperlink when a
 
 module-link::
        Text which will be used as the formatstring for a hyperlink when a


@@ -288,6 +304,12 @@ repo.group::
        Legacy alias for "section". This option is deprecated and will not be
        supported in cgit-1.0.
 
        Legacy alias for "section". This option is deprecated and will not be
        supported in cgit-1.0.
 

+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-sort.
+

 robots::
        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".
 robots::
        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".


@@ -328,11 +350,11 @@ section::
        after this option will inherit the current section name. Default value:
        none.
 
        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-sort::
+       Flag which, when set to "1", will sort the sections on the repository
+       listing by name. Set this flag to "0" if the order in the cgitrc file should
+       be preserved. Default value: "1". See also: section,
+       case-sensitive-sort, repository-sort.

 
 section-from-path::
        A number which, if specified before scan-path, specifies how many
 
 section-from-path::
        A number which, if specified before scan-path, specifies how many


@@ -392,6 +414,11 @@ repo.about-filter::
        Override the default about-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 
        Override the default about-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 

+repo.branch-sort::
+       Flag which, when set to "age", enables date ordering in the branch ref
+       list, and when set to "name" enables ordering by branch name. Default
+       value: "name".
+

 repo.clone-url::
        A list of space-separated urls which can be used to clone this repo.
        Default value: none. See also: "MACRO EXPANSION".
 repo.clone-url::
        A list of space-separated urls which can be used to clone this repo.
        Default value: none. See also: "MACRO EXPANSION".


@@ -400,6 +427,12 @@ repo.commit-filter::
        Override the default commit-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 
        Override the default commit-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 

+repo.commit-sort::
+       Flag which, when set to "date", enables strict date ordering in the
+       commit log, and when set to "topo" enables strict topological
+       ordering. If unset, the default ordering of "git log" is used. Default
+       value: unset.
+

 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
 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