cgitrc.5: document new signature notes

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>

1 file changed, 17 insertions, 1 deletion

diff --git a/cgitrc.5.txt b/cgitrc.5.txtindex 6f008cc..6b4efa2 100644--- a/cgitrc.5.txt+++ b/cgitrc.5.txt@@ -759,7 +759,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@@ -767,6 +767,22 @@ 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.+  EXAMPLE CGITRC FILE -------------------
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 6f008cc..6b4efa2 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -759,7 +759,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
@@ -767,6 +767,22 @@ 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.
+
 
 EXAMPLE CGITRC FILE
 -------------------