From b911f4c3217629b63ebfa2385e9f4a09a7278d1c Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Wed, 4 Oct 2023 16:29:52 +0100
Subject: doc: Note disregard of description field for remote repositories.

* doc/forge.skb (Reference)[<forge-project>]{description}: Note that
this field is disregarded for remote repositories.
---
 doc/forge.skb | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'doc')

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")
-- 
cgit v1.2.3