about: allow to give head from query

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index f6f6502fa2df7d754c8b698d9f54c67dc460a3cd..d9eb3b02d322e67759fb413e0f9fd27375fbeab1 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -407,9 +407,12 @@ side-by-side-diffs::
 snapshots::
        Text which specifies the default set of snapshot formats that cgit
        generates links for. The value is a space-separated list of zero or
-       more of the values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip".
-       The special value "all" enables all snapshot formats.
-       Default value: none.
+       more of the values "tar", "tar.gz", "tar.bz2", "tar.lz", "tar.xz",
+       "tar.zst" and "zip". The special value "all" enables all snapshot
+       formats. Default value: none.
+       All compressors use default settings. Some settings can be influenced
+       with environment variables, for example set ZSTD_CLEVEL=10 in web
+       server environment for higher (but slower) zstd compression.
 
 source-filter::
        Specifies a command which will be invoked to format plaintext blobs
@@ -485,6 +488,10 @@ repo.email-filter::
        Override the default email-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
 
+repo.enable-blame::
+       A flag which can be used to disable the global setting
+       `enable-blame'. Default value: none.
+
 repo.enable-commit-graph::
        A flag which can be used to disable the global setting
        `enable-commit-graph'. Default value: none.
@@ -509,6 +516,10 @@ repo.enable-subject-links::
        A flag which can be used to override the global setting
        `enable-subject-links'. Default value: none.
 
+repo.extra-head-content::
+       This value will be added verbatim to the head section of each page
+       displayed for this repo. Default value: none.
+
 repo.hide::
        Flag which, when set to "1", hides the repository from the repository
        index. The repository can still be accessed by providing a direct path.
@@ -568,11 +579,11 @@ repo.readme::
        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". If the value begins
-       with a colon, i.e. ":docs/readme.rst", the default branch of the
-       repository will be used. Sharing any file will expose that entire
-       directory tree to the "/about/PATH" endpoints, so be sure that there
-       are no non-public files located in the same directory as the readme
-       file. Default value: <readme>.
+       with a colon, i.e. ":docs/readme.rst", the head giving in query or
+       the default branch of the repository will be used. Sharing any file
+       will expose that entire directory tree to the "/about/PATH" endpoints,
+       so be sure that there are no non-public files located in the same
+       directory as the readme file. Default value: <readme>.
 
 repo.section::
        Override the current section name for this repository. Default value:
@@ -755,7 +766,7 @@ the environment variables defined in "FILTER API":
 
 
 CACHE
-------
+-----
 
 All cache ttl values are in minutes. Negative ttl values indicate that a page
 type will never expire, and thus the first time a URL is accessed, the result
@@ -763,6 +774,33 @@ will be cached indefinitely, even if the underlying git repository changes.
 Conversely, when a ttl value is zero, the cache is disabled for that
 particular page type, and the page type is never cached.
 
+SIGNATURES
+----------
+
+Cgit can host .asc signatures corresponding to various snapshot formats,
+through use of git notes. For example, the following command may be used to
+add a signature to a .tar.xz archive:
+
+    git notes --ref=refs/notes/signatures/tar.xz add -C "$(
+       gpg --output - --armor --detach-sign cgit-1.1.tar.xz |
+       git hash-object -w --stdin
+    )" v1.1
+
+If it is instead desirable to attach a signature of the underlying .tar, this
+will be linked, as a special case, beside a .tar.* link that does not have its
+own signature. For example, a signature of a tarball of the latest tag might
+be added with a similar command:
+
+    tag="$(git describe --abbrev=0)"
+    git notes --ref=refs/notes/signatures/tar add -C "$(
+        git archive --format tar --prefix "cgit-${tag#v}/" "$tag" |
+        gpg --output - --armor --detach-sign |
+        git hash-object -w --stdin
+    )" "$tag"
+
+Since git-archive(1) is expected to produce stable output between versions,
+this allows one to generate a long-term signature of the contents of a given
+tag.
 
 EXAMPLE CGITRC FILE
 -------------------