Add BTOPTIONS_PROC comments to nbtree.h.

petergeoghegan · petergeoghegan · commit 1c854eb8931a · 2025-01-13T15:02:14.000-05:00
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).
diff --git 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
