Merge branch 'lh/section-from-path'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 5d779733ddc3674a80d387d3bcb0c18dc0f9ab3d..ce78d419debc78718a3633aced47ec16feedea1f 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -234,6 +234,10 @@ project-list::
        should loaded as git repositories. This must be defined prior to
        scan-path. Default value: none. See also: scan-path.
 
        should loaded as git repositories. This must be defined prior to
        scan-path. Default value: none. See also: scan-path.
 

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


@@ -278,6 +282,12 @@ 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.
 

+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".
 side-by-side-diffs::
        If set to "1" shows side-by-side diffs instead of unidiffs per
        default. Default value: "0".


@@ -371,7 +381,9 @@ repo.path::
 
 repo.readme::
        A path (relative to <repo.path>) which specifies a file to include
 
 repo.readme::
        A path (relative to <repo.path>) which specifies a file to include

-       verbatim as the "About" page for this repo. Default value: none.
+       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
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the