mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix some markups for support functions of index AMs

Browse Source 
All the documentation of index AMs has been using <replaceable> for
local_relopts.  This is a structure, so <structname> is a much better
choice.

Alexander has found the inconsistency for btree, while I have spotted
the rest when applying the concept of consistency to the docs.

Author: Alexander Lakhin, Michael Paquier
Reviewed-by: Tom Lane
Discussion: https://postgr.es/m/20200822133022.GC24782@paquier.xyz
This commit is contained in:
Michael Paquier 2020-08-24 16:46:52 +09:00
parent a3c66de6c5
commit 77c1537f51
5 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -576,7 +576,7 @@ typedef struct BrinOpcInfo
<para>
The <function>options</function> function is passed a pointer to a
<replaceable>local_relopts</replaceable> struct, which needs to be
<structname>local_relopts</structname> struct, which needs to be
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

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

@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
<synopsis>
options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void
</synopsis>
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be 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

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

@ -412,7 +412,7 @@
<para>
The <function>options</function> function is passed a pointer to a
<replaceable>local_relopts</replaceable> struct, which needs to be
<structname>local_relopts</structname> struct, which needs to be
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

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

@ -962,7 +962,7 @@ LANGUAGE C STRICT;
</para>
<para>
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be 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

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

@ -897,7 +897,7 @@ LANGUAGE C STRICT;
</para>
<para>
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be 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