diff options
| author | Alexander Korotkov | 2020-06-21 01:48:03 +0000 |
|---|---|---|
| committer | Alexander Korotkov | 2020-06-21 01:51:32 +0000 |
| commit | 14903f238ec999802df5c539010c6be32d72f8cd (patch) | |
| tree | 8f689c74936f8bad4ad2eb163cc392e68f81428c /doc/src/sgml/btree.sgml | |
| parent | 48c6959864491964ae3f893af8242d5770b3d3d2 (diff) | |
Language fixes for docs related to opclass options
Discussion: https://postgr.es/m/20200620232145.GB17995%40telsasoft.com
Author: Justin Pryzby
Backpatch-through: 13
Diffstat (limited to 'doc/src/sgml/btree.sgml')
| -rw-r--r-- | doc/src/sgml/btree.sgml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml index 4f1438d522d..d03ee4d6fa0 100644 --- a/doc/src/sgml/btree.sgml +++ b/doc/src/sgml/btree.sgml @@ -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> |