Commit3c09d11

committed

Update DECLARE_INDEX documentation

1 parent4f3514f commit3c09d11Copy full SHA for 3c09d11

File tree

-5

lines changed

-5

lines changed

Lines changed: 6 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -71,12 +71,13 @@`
`71`	`71`	`* DECLARE_UNIQUE_INDEX_PKEY. ("PKEY" marks the index as being the catalog's`
`72`	`72`	`* primary key; currently this is only cosmetically different from a regular`
`73`	`73`	`* unique index. By convention, we usually make a catalog's OID column its`
`74`		`- * pkey, if it has one.) The first two arguments are the index's name and`
`75`		`- * OID, the rest is much like a standard 'create index' SQL command.`
	`74`	`+ * pkey, if it has one.)`
`76`	`75`	`*`
`77`		`- * For each index, we also provide a #define for its OID. References to`
`78`		`- * the index in the C code should always use these #defines, not the actual`
`79`		`- * index name (much less the numeric OID).`
	`76`	`+ * The first two arguments are the index's name and OID. The third argument`
	`77`	`+ * is the name of a #define to generate for its OID. References to the index`
	`78`	`+ * in the C code should always use these #defines, not the actual index name`
	`79`	`+ * (much less the numeric OID). The rest is much like a standard 'create`
	`80`	`+ * index' SQL command.`
`80`	`81`	`*`
`81`	`82`	`* The macro definitions are just to keep the C compiler from spitting up.`
`82`	`83`	`*/`

Comments

(0)