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

Commit 3be015c

Browse files
committed
Minor corrections to docs related to opclass options
Reported-by: Peter Geoghegan Discussion: https://postgr.es/m/CAH2-WzmwhYbxuoL0WjTLaiCxW3gj6qadeNpBhWAo_KZsE5-FGw%40mail.gmail.com
1 parent a44dd93 commit 3be015c

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

doc/src/sgml/btree.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207

208208
<para>
209209
As shown in <xref linkend="xindex-btree-support-table"/>, btree defines
210-
one required and three optional support functions. The four
210+
one required and four optional support functions. The five
211211
user-defined methods are:
212212
</para>
213213
<variablelist>

doc/src/sgml/spgist.sgml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@
284284

285285
<para>
286286
There are five user-defined methods that an index operator class for
287-
<acronym>SP-GiST</acronym> must provide, and one is optional. All five
287+
<acronym>SP-GiST</acronym> must provide, and two are optional. All five
288288
mandatory methods follow the convention of accepting two <type>internal</type>
289289
arguments, the first of which is a pointer to a C struct containing input
290290
values for the support method, while the second argument is a pointer to a
@@ -295,7 +295,9 @@
295295
cases, the output struct is initialized to zeroes before calling the
296296
user-defined method. The optional sixth method <function>compress</function>
297297
accepts datum to be indexed as the only argument and returns a value suitable
298-
for physical storage in a leaf tuple.
298+
for physical storage in a leaf tuple. The optional seventh method
299+
<function>options</function> accepts internal pointer to a C struct, where
300+
opclass-specific parameters should be placed, and returns <type>void</type>.
299301
</para>
300302

301303
<para>

0 commit comments

Comments
 (0)