Movatterモバイル変換

Skip to content

postgrespro/postgresPublic

forked frompostgres/postgres

NotificationsYou must be signed in to change notification settings
Fork6
Star31

Commit77c1537

michaelpq

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 commit77c1537Copy full SHA for 77c1537

File tree

5 files changed

+5

-5

lines changed

doc/src/sgml

5 files changed

+5

-5

lines changed

`‎doc/src/sgml/brin.sgml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -576,7 +576,7 @@ typedef struct BrinOpcInfo`
`576`	`576`
`577`	`577`	`<para>`
`578`	`578`	`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`
`580`	`580`	`filled with a set of operator class specific options. The options`
`581`	`581`	`can be accessed from other support functions using the`
`582`	`582`	`<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and`

`‎doc/src/sgml/btree.sgml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool`
`566`	`566`	`<synopsis>`
`567`	`567`	`options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void`
`568`	`568`	`</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>`
`570`	`570`	`struct, which needs to be filled with a set of operator class`
`571`	`571`	`specific options. The options can be accessed from other support`
`572`	`572`	`functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and`

`‎doc/src/sgml/gin.sgml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -412,7 +412,7 @@`
`412`	`412`
`413`	`413`	`<para>`
`414`	`414`	`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`
`416`	`416`	`filled with a set of operator class specific options. The options`
`417`	`417`	`can be accessed from other support functions using the`
`418`	`418`	`<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and`

`‎doc/src/sgml/gist.sgml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -962,7 +962,7 @@ LANGUAGE C STRICT;`
`962`	`962`	`</para>`
`963`	`963`
`964`	`964`	`<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>`
`966`	`966`	`struct, which needs to be filled with a set of operator class`
`967`	`967`	`specific options. The options can be accessed from other support`
`968`	`968`	`functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and`

`‎doc/src/sgml/spgist.sgml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -897,7 +897,7 @@ LANGUAGE C STRICT;`
`897`	`897`	`</para>`
`898`	`898`
`899`	`899`	`<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>`
`901`	`901`	`struct, which needs to be filled with a set of operator class`
`902`	`902`	`specific options. The options can be accessed from other support`
`903`	`903`	`functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and`

0 commit comments

Comments

(0)

[8]ページ先頭

©2009-2025 Movatter.jp