Update DECLARE_INDEX documentation
authorPeter Eisentraut <[email protected]>
Thu, 24 Aug 2023 11:59:40 +0000 (13:59 +0200)
committerPeter Eisentraut <[email protected]>
Thu, 24 Aug 2023 11:59:40 +0000 (13:59 +0200)
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

src/include/catalog/genbki.h

index 50518cbbf53ab485588f48fe47825e73da2101dd..c42ba0cea503c8b6cb79112bc5193047f2eaadf3 100644 (file)
  * 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.
  */