From: Peter Eisentraut <peter@eisentraut.org>
Date: Tue, 19 Aug 2025 06:03:53 +0000 (+0200)
Subject: Add src/include/catalog/README
X-Git-Url: http://git.postgresql.org/gitweb/?a=commitdiff_plain;h=16d434d53d56c5dd1919ca07274193ee2600ed1b;p=postgresql.git

Add src/include/catalog/README

This just includes a link to the bki documentation, to help people get
started.

Before commit 372728b0d49, there was a README at
src/backend/catalog/README, but then this was moved to the SGML
documentation.  So this effectively puts back a link to what was
moved.  But src/include/catalog/ is probably a better location,
because that's where all the interesting files are.

Co-authored-by: Florents Tselai <florents.tselai@gmail.com>
Discussion: https://www.postgresql.org/message-id/flat/CA+v5N400GJFJ9RyXAX7hFKbtF7vVQGvWdFWEfcSQmvVhi9xfrA@mail.gmail.com
---

diff --git a/src/include/catalog/README b/src/include/catalog/README
new file mode 100644
index 00000000000..7e0e5d7e70c
--- /dev/null
+++ b/src/include/catalog/README
@@ -0,0 +1,2 @@
+See <https://www.postgresql.org/docs/devel/bki.html> about the
+files in this directory.