doc: Fix some markups for support functions of index AMs

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

diff --git a/doc/src/sgml/brin.sgml b/doc/src/sgml/brin.sgml
index 55b6272db62e00148ecd3deed707faf8d5c0ba3c..b9d596e3c4e75d19fae1df9b485746490b6488b6 100644 (file)
--- a/doc/src/sgml/brin.sgml
+++ b/doc/src/sgml/brin.sgml
@@ -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

diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml
index d03ee4d6fa0d1a41bc26368a12035833c3db73cc..435b7cb24da94739aabe13f9cda453d8289a574a 100644 (file)
--- a/doc/src/sgml/btree.sgml
+++ b/doc/src/sgml/btree.sgml
@@ -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

diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml
index 07114f77199cec3adaac2f644c66bf0bc81027f9..2d862669c33767729d5fe3cce3133378e7e6063f 100644 (file)
--- a/doc/src/sgml/gin.sgml
+++ b/doc/src/sgml/gin.sgml
@@ -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

diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index 5d970ee9f2f453f042a2d2944d19ebf14bfa813a..a505815f4ec582a831154a9032180ac4d4e759d7 100644 (file)
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -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

diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml
index 5d6e893d49185fc19d20606b9eda21bfd82951ba..b86302e4efdee55f242233c552106f49ddcc660b 100644 (file)
--- a/doc/src/sgml/spgist.sgml
+++ b/doc/src/sgml/spgist.sgml
@@ -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