From bd1c918c98e7e9ebe4e2068e6dd45538cd69e7d8 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Sat, 12 Aug 2023 20:14:29 +0100
Subject: 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.
---
 doc/forge.skb | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'doc/forge.skb')

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