From 77c1537f512e6ac2513f8695c795dc94cbf207ee Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Mon, 24 Aug 2020 16:46:52 +0900 Subject: [PATCH] doc: Fix some markups for support functions of index AMs All the documentation of index AMs has been using for local_relopts. This is a structure, so 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 --- doc/src/sgml/brin.sgml | 2 +- doc/src/sgml/btree.sgml | 2 +- doc/src/sgml/gin.sgml | 2 +- doc/src/sgml/gist.sgml | 2 +- doc/src/sgml/spgist.sgml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/src/sgml/brin.sgml b/doc/src/sgml/brin.sgml index 55b6272db62..b9d596e3c4e 100644 --- a/doc/src/sgml/brin.sgml +++ b/doc/src/sgml/brin.sgml @@ -576,7 +576,7 @@ typedef struct BrinOpcInfo The options function is passed a pointer to a - local_relopts struct, which needs to be + local_relopts 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 PG_HAS_OPCLASS_OPTIONS() and diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml index d03ee4d6fa0..435b7cb24da 100644 --- a/doc/src/sgml/btree.sgml +++ b/doc/src/sgml/btree.sgml @@ -566,7 +566,7 @@ equalimage(opcintype oid) returns bool options(relopts local_relopts *) returns void - The function is passed a pointer to a local_relopts + The function is passed a pointer to a local_relopts 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 PG_HAS_OPCLASS_OPTIONS() and diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml index 07114f77199..2d862669c33 100644 --- a/doc/src/sgml/gin.sgml +++ b/doc/src/sgml/gin.sgml @@ -412,7 +412,7 @@ The options function is passed a pointer to a - local_relopts struct, which needs to be + local_relopts 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 PG_HAS_OPCLASS_OPTIONS() and 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; - The function is passed a pointer to a local_relopts + The function is passed a pointer to a local_relopts 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 PG_HAS_OPCLASS_OPTIONS() and diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml index 5d6e893d491..b86302e4efd 100644 --- a/doc/src/sgml/spgist.sgml +++ b/doc/src/sgml/spgist.sgml @@ -897,7 +897,7 @@ LANGUAGE C STRICT; - The function is passed a pointer to a local_relopts + The function is passed a pointer to a local_relopts 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 PG_HAS_OPCLASS_OPTIONS() and