database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-06-23 14:01:44 +03:00
Code Activity

Add BTOPTIONS_PROC comments to nbtree.h.

Browse Source 
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).
This commit is contained in:
Peter Geoghegan
2025-01-13 15:02:14 -05:00
parent 597b1ffbf1
commit 1c854eb893
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/include/access/nbtree.h
View File

@ -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