Commit 77c1537f authored by Michael Paquier's avatar Michael Paquier

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
parent a3c66de6
...@@ -576,7 +576,7 @@ typedef struct BrinOpcInfo ...@@ -576,7 +576,7 @@ typedef struct BrinOpcInfo
<para> <para>
The <function>options</function> function is passed a pointer to a 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 filled with a set of operator class specific options. The options
can be accessed from other support functions using the can be accessed from other support functions using the
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
......
...@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool ...@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
<synopsis> <synopsis>
options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void
</synopsis> </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 struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
......
...@@ -412,7 +412,7 @@ ...@@ -412,7 +412,7 @@
<para> <para>
The <function>options</function> function is passed a pointer to a 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 filled with a set of operator class specific options. The options
can be accessed from other support functions using the can be accessed from other support functions using the
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
......
...@@ -962,7 +962,7 @@ LANGUAGE C STRICT; ...@@ -962,7 +962,7 @@ LANGUAGE C STRICT;
</para> </para>
<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 struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
......
...@@ -897,7 +897,7 @@ LANGUAGE C STRICT; ...@@ -897,7 +897,7 @@ LANGUAGE C STRICT;
</para> </para>
<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 struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment