Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 1c854eb

Browse files
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 911e702, or in follow-up doc commit 15cb2bd (which documented support function 5 in btree.sgml, but neglected to add anything to nbtree.h).
1 parent 597b1ff commit 1c854eb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/include/access/nbtree.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,11 @@ BTreeTupleGetMaxHeapTID(IndexTuple itup)
702702
* To facilitate B-Tree deduplication, an operator class may choose to
703703
* offer a forth amproc procedure (BTEQUALIMAGE_PROC). For full details,
704704
* see doc/src/sgml/btree.sgml.
705+
*
706+
* An operator class may choose to offer a fifth amproc procedure
707+
* (BTOPTIONS_PROC). These procedures define a set of user-visible
708+
* parameters that can be used to control operator class behavior. None of
709+
* the built-in B-Tree operator classes currently register an "options" proc.
705710
*/
706711

707712
#define BTORDER_PROC 1

0 commit comments

Comments
 (0)