Minor corrections to docs related to opclass options
authorAlexander Korotkov <akorotkov@postgresql.org>
Sat, 20 Jun 2020 21:35:42 +0000 (00:35 +0300)
committerAlexander Korotkov <akorotkov@postgresql.org>
Sat, 20 Jun 2020 21:35:42 +0000 (00:35 +0300)
Reported-by: Peter Geoghegan
Discussion: https://postgr.es/m/CAH2-WzmwhYbxuoL0WjTLaiCxW3gj6qadeNpBhWAo_KZsE5-FGw%40mail.gmail.com

doc/src/sgml/btree.sgml
doc/src/sgml/spgist.sgml

index 2c4dd48ea35f576e421067efd4260c3fa3c02e89..661e7ab6503febf222529392f2afa8416dbbef5f 100644 (file)
 
  <para>
   As shown in <xref linkend="xindex-btree-support-table"/>, btree defines
-  one required and three optional support functions.  The four
+  one required and four optional support functions.  The five
   user-defined methods are:
  </para>
  <variablelist>
index 03f914735bdb7f9961f09cbad4658c8d4ba96a48..ad8d348a43dee33e83081b9cae20dd0d8a0b1356 100644 (file)
 
  <para>
   There are five user-defined methods that an index operator class for
-  <acronym>SP-GiST</acronym> must provide, and one is optional.  All five
+  <acronym>SP-GiST</acronym> must provide, and two are optional.  All five
   mandatory methods follow the convention of accepting two <type>internal</type>
   arguments, the first of which is a pointer to a C struct containing input
   values for the support method, while the second argument is a pointer to a
   cases, the output struct is initialized to zeroes before calling the
   user-defined method.  The optional sixth method <function>compress</function>
   accepts datum to be indexed as the only argument and returns a value suitable
-  for physical storage in a leaf tuple.
+  for physical storage in a leaf tuple.  The optional seventh method
+  <function>options</function> accepts internal pointer to a C struct, where
+  opclass-specific parameters should be placed, and returns <type>void</type>.
  </para>
 
  <para>