opensourcemirror
/
postgresql
mirror of git://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Language fixes for docs related to opclass options 

Discussion: https://postgr.es/m/20200620232145.GB17995%40telsasoft.com
Author: Justin Pryzby
Backpatch-through: 13
This commit is contained in:
Alexander Korotkov 2020-06-21 04:48:03 +03:00
parent 48c6959864
commit 14903f238e
6 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/sgml/brin.sgml
View File

@ -562,7 +562,7 @@ typedef struct BrinOpcInfo
</varlistentry>
</variablelist>
Optionally, an operator class for <acronym>BRIN</acronym> can supply the
An operator class for <acronym>BRIN</acronym> can optionally specify the
following method:
<variablelist>
@ -570,22 +570,22 @@ typedef struct BrinOpcInfo
<term><function>void options(local_relopts *relopts)</function></term>
<listitem>
<para>
Defines set of user-visible parameters that control operator class
Defines a set of user-visible parameters that control operator class
behavior.
</para>
<para>
The <function>options</function> function has given pointer to
The <function>options</function> function is passed a pointer to a
<replaceable>local_relopts</replaceable> struct, which needs to be
filled with a set of operator class specific options. The options
can be accessed from other support functions using
can be accessed from other support functions using the
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
<literal>PG_GET_OPCLASS_OPTIONS()</literal> macros.
</para>
<para>
Since both key extraction for indexed value and representation of the
key in <acronym>GIN</acronym> are flexible, it may depends on
Since both key extraction of indexed values and representation of the
key in <acronym>GIN</acronym> are flexible, they may depend on
user-specified parameters.
</para>
</listitem>

12
doc/src/sgml/btree.sgml
View File

@ -557,7 +557,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
Optionally, a B-tree operator family may provide
<function>options</function> (<quote>operator class specific
options</quote>) support functions, registered under support
function number 5. These functions define set of user-visible
function number 5. These functions define a set of user-visible
parameters that control operator class behavior.
</para>
<para>
@ -566,19 +566,19 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
<synopsis>
options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void
</synopsis>
The function has given pointer to <replaceable>local_relopts</replaceable>
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
<literal>PG_GET_OPCLASS_OPTIONS()</literal> macros.
</para>
<para>
Currently, no B-Tree operator class has <function>options</function>
Currently, no B-Tree operator class has an <function>options</function>
support function. B-tree doesn't allow flexible representation of keys
like GiST, SP-GiST, GIN and BRIN do. So, <function>options</function>
probably doesn't have much usage in current shape of B-tree index
probably doesn't have much application in the current B-tree index
access method. Nevertheless, this support function was added to B-tree
for uniformity, and probably it will found its usage during further
for uniformity, and will probably find uses during further
evolution of B-tree in <productname>PostgreSQL</productname>.
</para>
</listitem>

10
doc/src/sgml/gin.sgml
View File

@ -411,17 +411,17 @@
</para>
<para>
The <function>options</function> function has given pointer to
The <function>options</function> function is passed a pointer to a
<replaceable>local_relopts</replaceable> struct, which needs to be
filled with s set of operator class specific options. The options
can be accessed from other support functions using
filled with a set of operator class specific options. The options
can be accessed from other support functions using the
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
<literal>PG_GET_OPCLASS_OPTIONS()</literal> macros.
</para>
<para>
Since both key extraction for indexed value and representation of the
key in <acronym>GIN</acronym> are flexible, it may depends on
Since both key extraction of indexed values and representation of the
key in <acronym>GIN</acronym> are flexible, they may depend on
user-specified parameters.
</para>
</listitem>

18
doc/src/sgml/gist.sgml
View File

@ -946,7 +946,7 @@ my_fetch(PG_FUNCTION_ARGS)
<term><function>options</function></term>
<listitem>
<para>
Allows defintion of user-visible parameters that control operator
Allows definition of user-visible parameters that control operator
class behavior.
</para>
@ -962,16 +962,16 @@ LANGUAGE C STRICT;
</para>
<para>
The function has given pointer to <replaceable>local_relopts</replaceable>
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
<literal>PG_GET_OPCLASS_OPTIONS()</literal> macros.
</para>
<para>
The sample implementation of my_option() and parameters usage
in the another support function are given below:
An example implementation of my_options() and parameters use
from other support functions are given below:
<programlisting>
typedef enum MyEnumType
@ -990,7 +990,7 @@ typedef struct
int str_param; /* string parameter */
} MyOptionsStruct;
/* String representations for enum values */
/* String representation of enum values */
static relopt_enum_elt_def myEnumValues[] =
{
{"on", MY_ENUM_ON},
@ -1002,7 +1002,7 @@ static relopt_enum_elt_def myEnumValues[] =
static char *str_param_default = "default";
/*
* Sample validatior: checks that string is not longer than 8 bytes.
* Sample validator: checks that string is not longer than 8 bytes.
*/
static void
validate_my_string_relopt(const char *value)
@ -1090,8 +1090,8 @@ my_compress(PG_FUNCTION_ARGS)
<para>
Since the representation of the key in <acronym>GiST</acronym> is
flexible, it may depends on user-specified parameters. For instace,
the length of key signature may be such parameter. See
flexible, it may depend on user-specified parameters. For instance,
the length of key signature may be specified. See
<literal>gtsvector_options()</literal> for example.
</para>
</listitem>

12
doc/src/sgml/spgist.sgml
View File

@ -290,13 +290,13 @@
values for the support method, while the second argument is a pointer to a
C struct where output values must be placed. Four of the mandatory methods just
return <type>void</type>, since all their results appear in the output struct; but
<function>leaf_consistent</function> additionally returns a <type>boolean</type> result.
<function>leaf_consistent</function> returns a <type>boolean</type> result.
The methods must not modify any fields of their input structs. In all
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
accepts a <type>datum</type> to be indexed as the only argument and returns a value suitable
for physical storage in a leaf tuple. The optional seventh method
<function>options</function> accepts internal pointer to a C struct, where
<function>options</function> accepts an <type>internal</type> pointer to a C struct, where
opclass-specific parameters should be placed, and returns <type>void</type>.
</para>
@ -897,16 +897,16 @@ LANGUAGE C STRICT;
</para>
<para>
The function has given pointer to <replaceable>local_relopts</replaceable>
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
<literal>PG_GET_OPCLASS_OPTIONS()</literal> macros.
</para>
<para>
Since the representation of the key in <acronym>SP-GiST</acronym> is
flexible, it may depends on user-specified parameters.
flexible, it may depend on user-specified parameters.
</para>
</listitem>
</varlistentry>

18
doc/src/sgml/xindex.sgml
View File

@ -410,9 +410,9 @@
</para>
<para>
Additionally, some opclasses allow user to set specific parameters, which
controls its behavior. Each builtin index access method have optional
<function>options</function> support function, which defines set of
Additionally, some opclasses allow users to specify parameters which
control their behavior. Each builtin index access method has an optional
<function>options</function> support function, which defines a set of
opclass-specific parameters.
</para>
@ -459,7 +459,7 @@
</row>
<row>
<entry>
Defines set of options that are specific for this operator class
Defines a set of options that are specific to this operator class
(optional)
</entry>
<entry>5</entry>
@ -501,7 +501,7 @@
</row>
<row>
<entry>
Defines set of options that are specific for this operator class
Defines a set of options that are specific to this operator class
(optional)
</entry>
<entry>3</entry>
@ -584,7 +584,7 @@
<row>
<entry><function>options</function></entry>
<entry>
Defines set of options that are specific for this operator class
Defines a set of options that are specific to this operator class
(optional)
</entry>
<entry>10</entry>
@ -643,7 +643,7 @@
<row>
<entry><function>options</function></entry>
<entry>
Defines set of options that are specific for this operator class
Defines a set of options that are specific to this operator class
(optional)
</entry>
<entry>6</entry>
@ -720,7 +720,7 @@
<row>
<entry><function>options</function></entry>
<entry>
Defines set of options that are specific for this operator class
Defines a set of options that are specific to this operator class
(optional)
</entry>
<entry>7</entry>
@ -778,7 +778,7 @@
<row>
<entry><function>options</function></entry>
<entry>
Defines set of options that are specific for this operator class
Defines a set of options that are specific to this operator class
(optional)
</entry>
<entry>5</entry>