diff options
| author | Peter Geoghegan <pg@bowt.ie> | 2025-01-13 15:02:14 -0500 |
|---|---|---|
| committer | Peter Geoghegan <pg@bowt.ie> | 2025-01-13 15:02:14 -0500 |
| commit | 1c854eb8931a8ce2ba8e2cc4d0a209a45d836de5 (patch) | |
| tree | bce1469379556787ec371dd26b7c56c126700c6c | |
| parent | 597b1ffbf12352a3863a894f16741864aaf2242f (diff) | |
| download | postgresql-1c854eb8931a8ce2ba8e2cc4d0a209a45d836de5.tar.gz postgresql-1c854eb8931a8ce2ba8e2cc4d0a209a45d836de5.zip | |
Add BTOPTIONS_PROC comments to nbtree.h.
Add comments explaining the purpose of B-Tree support function 5 to
nbtree.h for consistency (all other support functions were already
described by nearby comments).
This fixes what was arguably an oversight in commit 911e702077, or in
follow-up doc commit 15cb2bd2 (which documented support function 5 in
btree.sgml, but neglected to add anything to nbtree.h).
| -rw-r--r-- | src/include/access/nbtree.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/include/access/nbtree.h b/src/include/access/nbtree.h index 8dcfe5674c6..6a501537e1e 100644 --- a/src/include/access/nbtree.h +++ b/src/include/access/nbtree.h @@ -702,6 +702,11 @@ BTreeTupleGetMaxHeapTID(IndexTuple itup) * To facilitate B-Tree deduplication, an operator class may choose to * offer a forth amproc procedure (BTEQUALIMAGE_PROC). For full details, * see doc/src/sgml/btree.sgml. + * + * An operator class may choose to offer a fifth amproc procedure + * (BTOPTIONS_PROC). These procedures define a set of user-visible + * parameters that can be used to control operator class behavior. None of + * the built-in B-Tree operator classes currently register an "options" proc. */ #define BTORDER_PROC 1 |