Date: Sun, 23 Aug 2020 21:11:58 +0900
From: Michael Paquier <michael@paquier.xyz>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Alexander Lakhin <exclusion@gmail.com>,
	"pgsql-docs@postgresql.org" <pgsql-docs@postgresql.org>
Subject: Re: Minor fixes for PostgreSQL 13 documentation
Message-ID: <20200823121158.GD24782@paquier.xyz>
References: <a2345841-10a5-4eef-257c-02302347cf39@gmail.com>
 <20200822133022.GC24782@paquier.xyz>
 <2146373.1598108812@sss.pgh.pa.us>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="gdTfX7fkYsEEjebm"
Content-Disposition: inline
In-Reply-To: <2146373.1598108812@sss.pgh.pa.us>
Precedence: bulk


--gdTfX7fkYsEEjebm
Content-Type: multipart/mixed; boundary="dFWYt1i2NyOo1oI9"
Content-Disposition: inline


--dFWYt1i2NyOo1oI9
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Sat, Aug 22, 2020 at 11:06:52AM -0400, Tom Lane wrote:
> Michael Paquier <michael@paquier.xyz> writes:
>> The docs of brin, gin, gist and spgist disagree with that.  Wouldn't
>> it be better to update all of them?
>=20
> Yeah, probably.  See 47046763c for some policy I'd made up about when
> to use <replaceable> --- typedef names definitely don't fit.

I have looked again at the documentation and found just the five
places mentioned previously, giving the attached.
--
Michael

--dFWYt1i2NyOo1oI9
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="doc-structname.patch"
Content-Transfer-Encoding: quoted-printable

diff --git a/doc/src/sgml/brin.sgml b/doc/src/sgml/brin.sgml
index 55b6272db6..b9d596e3c4 100644
--- a/doc/src/sgml/brin.sgml
+++ b/doc/src/sgml/brin.sgml
@@ -576,7 +576,7 @@ typedef struct BrinOpcInfo
=20
       <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 d03ee4d6fa..435b7cb24d 100644
--- a/doc/src/sgml/btree.sgml
+++ b/doc/src/sgml/btree.sgml
@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>o=
id</type>) returns bool
 <synopsis>
 options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) r=
eturns void
 </synopsis>
-     The function is passed a pointer to a <replaceable>local_relopts</rep=
laceable>
+     The function is passed a pointer to a <structname>local_relopts</stru=
ctname>
      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 07114f7719..2d862669c3 100644
--- a/doc/src/sgml/gin.sgml
+++ b/doc/src/sgml/gin.sgml
@@ -412,7 +412,7 @@
=20
       <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 5d970ee9f2..a505815f4e 100644
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -962,7 +962,7 @@ LANGUAGE C STRICT;
       </para>
=20
       <para>
-       The function is passed a pointer to a <replaceable>local_relopts</r=
eplaceable>
+       The function is passed a pointer to a <structname>local_relopts</st=
ructname>
        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 5d6e893d49..b86302e4ef 100644
--- a/doc/src/sgml/spgist.sgml
+++ b/doc/src/sgml/spgist.sgml
@@ -897,7 +897,7 @@ LANGUAGE C STRICT;
       </para>
=20
       <para>
-       The function is passed a pointer to a <replaceable>local_relopts</r=
eplaceable>
+       The function is passed a pointer to a <structname>local_relopts</st=
ructname>
        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

--dFWYt1i2NyOo1oI9--

--gdTfX7fkYsEEjebm
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAl9CXQ4ACgkQnvQgOdby
QH2KYw/8CtO9al48H3clbiXeyZ10ugZaAatTh/5QiC54BSnNNWYXZlgsIBeRg7jG
DIEkHJ4j+dkKzapoPOY5iqZHcJzmqzoTPXoSJJbpEfD/4aw7TtPskKcPmeR7hQYl
Op8s/BZ3nVxncCvO/mii8VjMA/X91z280OsNtCen03FiqSjQF2JRdKW4s+PJ0oi9
BJmue5DT9O+gfUBbJ8q3FaCPkt5V7IRnqjpGDI/6lo2EJAUwMmEWjNrPu+b62rks
j7fSGsQwRePbRNukUucBdGQIsIfb570V8VwrVDnPvsGXsm0MdnbDLyn4w2JJzPwA
6OrDqI7wK694XOTcu6AAcRSbbclRky99LmVgvCOxkB8vVZ1eR+Y54vF/e+fwrXIE
ElLgG8zMCIidf+H3PpS/uUuBAe7jwiVjVT1H+OLyIQRTyAXFbqzq030l+OJBuUjq
Zo1IyM97z3deU2Ie30M5sA7O7sAzrvPCOVXNNXAqjRzd4SQiyJNe1ZQCAktuzasy
bOOeJ+8tigX3BnrnqgdwpFGFirrs5/hDb1ygR3/8PNolvZdPxPv5ZwriJ9mAN7a2
3eYO7VGdM2+QY+OUw/2Ebzdz8eb3LzXWFP6Db543XcBppLJ64rAaOW0RJM3C+e0M
SJ+tUrFmBRzwOlrEa2/hD8YyPJ4gWwljz6oZkJseZZXoUyb9w9Q=
=lIKI
-----END PGP SIGNATURE-----

--gdTfX7fkYsEEjebm--