summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2023-10-04 16:29:52 +0100
committerArun Isaac2023-10-04 16:29:52 +0100
commitb911f4c3217629b63ebfa2385e9f4a09a7278d1c (patch)
tree591cee9eaf1cf3daa27ec67ae7c99927b569187f /doc
parent9ce2e5be41c0a1dc509037534a57918bc7a724d2 (diff)
downloadguix-forge-b911f4c3217629b63ebfa2385e9f4a09a7278d1c.tar.gz
guix-forge-b911f4c3217629b63ebfa2385e9f4a09a7278d1c.tar.lz
guix-forge-b911f4c3217629b63ebfa2385e9f4a09a7278d1c.zip
doc: Note disregard of description field for remote repositories.v0.1.0
* doc/forge.skb (Reference)[<forge-project>]{description}: Note that this field is disregarded for remote repositories.
Diffstat (limited to 'doc')
-rw-r--r--doc/forge.skb3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index ea33ee6..b141bb6 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -516,7 +516,8 @@ disregarded if the repository is remote.])
(record-field "description"
[Short one-line description of the project. It is used to set
the ,(file "description") file in the repository and will appear in
-the cgit web interface.])
+the cgit web interface. This field is disregarded if the repository is
+remote.])
(record-field "website-directory"
[Path to the document root of the project website. The
ownership of its parent directory is granted to the ,(code "laminar")