postgres.git / summary / log / commit / refs

commit    4cdcff4d93b202fd30e6b3927874af9002247779
Author:   Peter Eisentraut <peter@eisentraut.org>
Date:     Thu Aug 24 11:59:40 2023 +0000
First released in: 17.0, 15.5, 16.0

    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


src/include/catalog/genbki.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/include/catalog/genbki.h b/src/include/catalog/genbki.h index 50518cbbf53..c42ba0cea50 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. */ [parent: 155c81463c26]