aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2023-08-12 20:14:29 +0100
committerArun Isaac2023-08-12 20:14:29 +0100
commitbd1c918c98e7e9ebe4e2068e6dd45538cd69e7d8 (patch)
tree0e4e376fe90772ebb7a8bd7479c0a8cb708d0ec8
parent956a48586e13a3ca3beeb62936993ea45681460f (diff)
downloadguix-forge-bd1c918c98e7e9ebe4e2068e6dd45538cd69e7d8.tar.gz
guix-forge-bd1c918c98e7e9ebe4e2068e6dd45538cd69e7d8.tar.lz
guix-forge-bd1c918c98e7e9ebe4e2068e6dd45538cd69e7d8.zip
doc: Clarify that README files for cgit must be in the default branch.
* doc/forge.skb (Services)[Git web viewers]{cgit service}: Clarify that README files are looked up in the default branch.
-rw-r--r--doc/forge.skb5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index 27ef36f..8d59bef 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -221,8 +221,9 @@ smart HTTP protocol backend.])
[Socket that the internal cgit fcgiwrap instance listens on])
(record-field "readme"
[README file to serve as the ,(emph [About]) page of the
-repository. This field is a list of candidate README files. cgit will
-serve the first file that is found.])
+repository. This field is a list of candidate README files looked up
+in the default branch of the repository. cgit will serve the first
+file that is found.])
(record-field "snapshots"
[List of strings specifying snapshot formats that cgit
generates links for. Valid strings are ,(code ["tar"]), ,(code