aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPeter Eisentraut <peter@eisentraut.org>2023-08-24 13:59:40 +0200
committerPeter Eisentraut <peter@eisentraut.org>2023-08-24 14:00:54 +0200
commit908f711d2398f87af1c7982c4376d04a09737faf (patch)
treef193b3ba6fccf48baa2ad05841b66d6ba8e521aa /src
parente4693c68a497129ea3913148027a6cee3b522d5d (diff)
downloadpostgresql-908f711d2398f87af1c7982c4376d04a09737faf.tar.gz
postgresql-908f711d2398f87af1c7982c4376d04a09737faf.zip
Update DECLARE_INDEX documentation
Update source code comment changes belonging to the changes in 6a6389a08b. Discussion: https://www.postgresql.org/message-id/flat/75ae5875-3abc-dafc-8aec-73247ed41cde@eisentraut.org
Diffstat (limited to 'src')
-rw-r--r--src/include/catalog/genbki.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/include/catalog/genbki.h b/src/include/catalog/genbki.h
index 992b7842363..f7b491f7bde 100644
--- a/src/include/catalog/genbki.h
+++ b/src/include/catalog/genbki.h
@@ -71,12 +71,13 @@
* DECLARE_UNIQUE_INDEX_PKEY. ("PKEY" marks the index as being the catalog's
* primary key; currently this is only cosmetically different from a regular
* unique index. By convention, we usually make a catalog's OID column its
- * pkey, if it has one.) The first two arguments are the index's name and
- * OID, the rest is much like a standard 'create index' SQL command.
+ * pkey, if it has one.)
*
- * For each index, we also provide a #define for its OID. References to
- * the index in the C code should always use these #defines, not the actual
- * index name (much less the numeric OID).
+ * The first two arguments are the index's name and OID. The third argument
+ * is the name of a #define to generate for its OID. References to the index
+ * in the C code should always use these #defines, not the actual index name
+ * (much less the numeric OID). The rest is much like a standard 'create
+ * index' SQL command.
*
* The macro definitions are just to keep the C compiler from spitting up.
*/