postgres.git / summary / log / commit / refs

commit    1c854eb8931a8ce2ba8e2cc4d0a209a45d836de5
Author:   Peter Geoghegan <pg@bowt.ie>
Date:     Mon Jan 13 20:02:14 2025 +0000
First released in: 18.0

    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).


 src/include/access/nbtree.h | 5 +++++
 1 file changed, 5 insertions(+)

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


[parent: 597b1ffbf123]