diff options
| author | Alexander Korotkov | 2020-06-20 21:35:42 +0000 |
|---|---|---|
| committer | Alexander Korotkov | 2020-06-20 21:35:42 +0000 |
| commit | 3be015c9fc02316f1f1579301391fb5c67731057 (patch) | |
| tree | 7e918ee054ecc6205f33c59af196685e8a713a38 | |
| parent | a44dd932ff3816de7fe0414063cfcc5656117c3a (diff) | |
Minor corrections to docs related to opclass options
Reported-by: Peter Geoghegan
Discussion: https://postgr.es/m/CAH2-WzmwhYbxuoL0WjTLaiCxW3gj6qadeNpBhWAo_KZsE5-FGw%40mail.gmail.com
| -rw-r--r-- | doc/src/sgml/btree.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/spgist.sgml | 6 |
2 files changed, 5 insertions, 3 deletions
diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml index 2c4dd48ea3..661e7ab650 100644 --- a/doc/src/sgml/btree.sgml +++ b/doc/src/sgml/btree.sgml @@ -207,7 +207,7 @@ <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> diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml index 03f914735b..ad8d348a43 100644 --- a/doc/src/sgml/spgist.sgml +++ b/doc/src/sgml/spgist.sgml @@ -284,7 +284,7 @@ <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 @@ -295,7 +295,9 @@ 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> |