diff options
| author | Michael Paquier <michael@paquier.xyz> | 2020-08-24 16:46:52 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2020-08-24 16:46:52 +0900 |
| commit | 77c1537f512e6ac2513f8695c795dc94cbf207ee (patch) | |
| tree | 690c25322ef492dc07af797a31389421920b869b /doc/src/sgml/gist.sgml | |
| parent | a3c66de6c5e1ee9dd41ce1454496568622fb7712 (diff) | |
| download | postgresql-77c1537f512e6ac2513f8695c795dc94cbf207ee.tar.gz postgresql-77c1537f512e6ac2513f8695c795dc94cbf207ee.zip | |
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
Diffstat (limited to 'doc/src/sgml/gist.sgml')
| -rw-r--r-- | doc/src/sgml/gist.sgml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml index 5d970ee9f2f..a505815f4ec 100644 --- 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 |