Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit77c1537

Browse files
committed
doc: Fix some markups for support functions of index AMs
All the documentation of index AMs has been using <replaceable> forlocal_relopts. This is a structure, so <structname> is a much betterchoice.Alexander has found the inconsistency for btree, while I have spottedthe rest when applying the concept of consistency to the docs.Author: Alexander Lakhin, Michael PaquierReviewed-by: Tom LaneDiscussion:https://postgr.es/m/20200822133022.GC24782@paquier.xyz
1 parenta3c66de commit77c1537

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

‎doc/src/sgml/brin.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ typedef struct BrinOpcInfo
576576

577577
<para>
578578
The <function>options</function> function is passed a pointer to a
579-
<replaceable>local_relopts</replaceable> struct, which needs to be
579+
<structname>local_relopts</structname> struct, which needs to be
580580
filled with a set of operator class specific options. The options
581581
can be accessed from other support functions using the
582582
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and

‎doc/src/sgml/btree.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
566566
<synopsis>
567567
options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void
568568
</synopsis>
569-
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
569+
The function is passed a pointer to a <structname>local_relopts</structname>
570570
struct, which needs to be filled with a set of operator class
571571
specific options. The options can be accessed from other support
572572
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and

‎doc/src/sgml/gin.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@
412412

413413
<para>
414414
The <function>options</function> function is passed a pointer to a
415-
<replaceable>local_relopts</replaceable> struct, which needs to be
415+
<structname>local_relopts</structname> struct, which needs to be
416416
filled with a set of operator class specific options. The options
417417
can be accessed from other support functions using the
418418
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and

‎doc/src/sgml/gist.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -962,7 +962,7 @@ LANGUAGE C STRICT;
962962
</para>
963963

964964
<para>
965-
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
965+
The function is passed a pointer to a <structname>local_relopts</structname>
966966
struct, which needs to be filled with a set of operator class
967967
specific options. The options can be accessed from other support
968968
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and

‎doc/src/sgml/spgist.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -897,7 +897,7 @@ LANGUAGE C STRICT;
897897
</para>
898898

899899
<para>
900-
The function is passed a pointer to a <replaceable>local_relopts</replaceable>
900+
The function is passed a pointer to a <structname>local_relopts</structname>
901901
struct, which needs to be filled with a set of operator class
902902
specific options. The options can be accessed from other support
903903
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp