Skip to content

Commit f7e508a

Browse files
peterepetere
committed
Make the placeholder naming in the synopses of the SQL help more consistent
1 parent 7ef5ffd commit f7e508a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+284
-284
lines changed

‎doc/src/sgml/ref/alter_conversion.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_conversion.sgml,v 1.9 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_conversion.sgml,v 1.10 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,8 +21,8 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER CONVERSION <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
25-
ALTER CONVERSION <replaceable>name</replaceable> OWNER TO <replaceable>newowner</replaceable>
24+
ALTER CONVERSION <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable>
25+
ALTER CONVERSION <replaceable>name</replaceable> OWNER TO <replaceable>new_owner</replaceable>
2626
</synopsis>
2727
</refsynopsisdiv>
2828

@@ -59,7 +59,7 @@ ALTER CONVERSION <replaceable>name</replaceable> OWNER TO <replaceable>newowner<
5959
</varlistentry>
6060

6161
<varlistentry>
62-
<term><replaceable class="parameter">newname</replaceable></term>
62+
<term><replaceable class="parameter">new_name</replaceable></term>
6363
<listitem>
6464
<para>
6565
The new name of the conversion.
@@ -68,7 +68,7 @@ ALTER CONVERSION <replaceable>name</replaceable> OWNER TO <replaceable>newowner<
6868
</varlistentry>
6969

7070
<varlistentry>
71-
<term><replaceable class="parameter">newowner</replaceable></term>
71+
<term><replaceable class="parameter">new_owner</replaceable></term>
7272
<listitem>
7373
<para>
7474
The new owner of the conversion.

‎doc/src/sgml/ref/alter_database.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.23 2009/09/18 05:00:41 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.24 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -27,7 +27,7 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <rep
2727

2828
CONNECTION LIMIT <replaceable class="PARAMETER">connlimit</replaceable>
2929

30-
ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
30+
ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>new_name</replaceable>
3131

3232
ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> OWNER TO <replaceable>new_owner</replaceable>
3333

@@ -117,7 +117,7 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
117117
</varlistentry>
118118

119119
<varlistentry>
120-
<term><replaceable>newname</replaceable></term>
120+
<term><replaceable>new_name</replaceable></term>
121121
<listitem>
122122
<para>
123123
The new name of the database.

‎doc/src/sgml/ref/alter_group.sgml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.18 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.19 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,10 +21,10 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> ADD USER <replaceable class="PARAMETER">username</replaceable> [, ... ]
25-
ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> DROP USER <replaceable class="PARAMETER">username</replaceable> [, ... ]
24+
ALTER GROUP <replaceable class="PARAMETER">group_name</replaceable> ADD USER <replaceable class="PARAMETER">user_name</replaceable> [, ... ]
25+
ALTER GROUP <replaceable class="PARAMETER">group_name</replaceable> DROP USER <replaceable class="PARAMETER">user_name</replaceable> [, ... ]
2626

27-
ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> RENAME TO <replaceable>newname</replaceable>
27+
ALTER GROUP <replaceable class="PARAMETER">group_name</replaceable> RENAME TO <replaceable>new_name</replaceable>
2828
</synopsis>
2929
</refsynopsisdiv>
3030

@@ -60,7 +60,7 @@ ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> RENAME TO <re
6060

6161
<variablelist>
6262
<varlistentry>
63-
<term><replaceable class="PARAMETER">groupname</replaceable></term>
63+
<term><replaceable class="PARAMETER">group_name</replaceable></term>
6464
<listitem>
6565
<para>
6666
The name of the group (role) to modify.
@@ -69,7 +69,7 @@ ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> RENAME TO <re
6969
</varlistentry>
7070

7171
<varlistentry>
72-
<term><replaceable class="PARAMETER">username</replaceable></term>
72+
<term><replaceable class="PARAMETER">user_name</replaceable></term>
7373
<listitem>
7474
<para>
7575
Users (roles) that are to be added to or removed from the group.
@@ -80,7 +80,7 @@ ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> RENAME TO <re
8080
</varlistentry>
8181

8282
<varlistentry>
83-
<term><replaceable>newname</replaceable></term>
83+
<term><replaceable>new_name</replaceable></term>
8484
<listitem>
8585
<para>
8686
The new name of the group.

‎doc/src/sgml/ref/alter_language.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_language.sgml,v 1.8 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_language.sgml,v 1.9 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,7 +21,7 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER [ PROCEDURAL ] LANGUAGE <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
24+
ALTER [ PROCEDURAL ] LANGUAGE <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable>
2525
ALTER [ PROCEDURAL ] LANGUAGE <replaceable>name</replaceable> OWNER TO <replaceable>new_owner</replaceable>
2626
</synopsis>
2727
</refsynopsisdiv>
@@ -51,7 +51,7 @@ ALTER [ PROCEDURAL ] LANGUAGE <replaceable>name</replaceable> OWNER TO <replacea
5151
</varlistentry>
5252

5353
<varlistentry>
54-
<term><replaceable>newname</replaceable></term>
54+
<term><replaceable>new_name</replaceable></term>
5555
<listitem>
5656
<para>
5757
The new name of the language

‎doc/src/sgml/ref/alter_opclass.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_opclass.sgml,v 1.9 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_opclass.sgml,v 1.10 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,8 +21,8 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> RENAME TO <replaceable>newname</replaceable>
25-
ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> OWNER TO <replaceable>newowner</replaceable>
24+
ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> RENAME TO <replaceable>new_name</replaceable>
25+
ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> OWNER TO <replaceable>new_owner</replaceable>
2626
</synopsis>
2727
</refsynopsisdiv>
2828

@@ -69,7 +69,7 @@ ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="p
6969
</varlistentry>
7070

7171
<varlistentry>
72-
<term><replaceable class="parameter">newname</replaceable></term>
72+
<term><replaceable class="parameter">new_name</replaceable></term>
7373
<listitem>
7474
<para>
7575
The new name of the operator class.
@@ -78,7 +78,7 @@ ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="p
7878
</varlistentry>
7979

8080
<varlistentry>
81-
<term><replaceable class="parameter">newowner</replaceable></term>
81+
<term><replaceable class="parameter">new_owner</replaceable></term>
8282
<listitem>
8383
<para>
8484
The new owner of the operator class.

‎doc/src/sgml/ref/alter_operator.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_operator.sgml,v 1.4 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_operator.sgml,v 1.5 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,7 +21,7 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER OPERATOR <replaceable>name</replaceable> ( { <replaceable>lefttype</replaceable> | NONE } , { <replaceable>righttype</replaceable> | NONE } ) OWNER TO <replaceable>newowner</replaceable>
24+
ALTER OPERATOR <replaceable>name</replaceable> ( { <replaceable>left_type</replaceable> | NONE } , { <replaceable>right_type</replaceable> | NONE } ) OWNER TO <replaceable>new_owner</replaceable>
2525
</synopsis>
2626
</refsynopsisdiv>
2727

@@ -58,7 +58,7 @@ ALTER OPERATOR <replaceable>name</replaceable> ( { <replaceable>lefttype</replac
5858
</varlistentry>
5959

6060
<varlistentry>
61-
<term><replaceable class="parameter">lefttype</replaceable></term>
61+
<term><replaceable class="parameter">left_type</replaceable></term>
6262
<listitem>
6363
<para>
6464
The data type of the operator's left operand; write
@@ -68,7 +68,7 @@ ALTER OPERATOR <replaceable>name</replaceable> ( { <replaceable>lefttype</replac
6868
</varlistentry>
6969

7070
<varlistentry>
71-
<term><replaceable class="parameter">righttype</replaceable></term>
71+
<term><replaceable class="parameter">right_type</replaceable></term>
7272
<listitem>
7373
<para>
7474
The data type of the operator's right operand; write
@@ -78,7 +78,7 @@ ALTER OPERATOR <replaceable>name</replaceable> ( { <replaceable>lefttype</replac
7878
</varlistentry>
7979

8080
<varlistentry>
81-
<term><replaceable class="parameter">newowner</replaceable></term>
81+
<term><replaceable class="parameter">new_owner</replaceable></term>
8282
<listitem>
8383
<para>
8484
The new owner of the operator.

‎doc/src/sgml/ref/alter_opfamily.sgml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_opfamily.sgml,v 1.5 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_opfamily.sgml,v 1.6 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -23,14 +23,14 @@ PostgreSQL documentation
2323
<synopsis>
2424
ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> ADD
2525
{ OPERATOR <replaceable class="parameter">strategy_number</replaceable> <replaceable class="parameter">operator_name</replaceable> ( <replaceable class="parameter">op_type</replaceable>, <replaceable class="parameter">op_type</replaceable> )
26-
| FUNCTION <replaceable class="parameter">support_number</replaceable> [ ( <replaceable class="parameter">op_type</replaceable> [ , <replaceable class="parameter">op_type</replaceable> ] ) ] <replaceable class="parameter">funcname</replaceable> ( <replaceable class="parameter">argument_type</replaceable> [, ...] )
26+
| FUNCTION <replaceable class="parameter">support_number</replaceable> [ ( <replaceable class="parameter">op_type</replaceable> [ , <replaceable class="parameter">op_type</replaceable> ] ) ] <replaceable class="parameter">function_name</replaceable> ( <replaceable class="parameter">argument_type</replaceable> [, ...] )
2727
} [, ... ]
2828
ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> DROP
2929
{ OPERATOR <replaceable class="parameter">strategy_number</replaceable> ( <replaceable class="parameter">op_type</replaceable> [ , <replaceable class="parameter">op_type</replaceable> ] )
3030
| FUNCTION <replaceable class="parameter">support_number</replaceable> ( <replaceable class="parameter">op_type</replaceable> [ , <replaceable class="parameter">op_type</replaceable> ] )
3131
} [, ... ]
32-
ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> RENAME TO <replaceable>newname</replaceable>
33-
ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> OWNER TO <replaceable>newowner</replaceable>
32+
ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> RENAME TO <replaceable>new_name</replaceable>
33+
ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> OWNER TO <replaceable>new_owner</replaceable>
3434
</synopsis>
3535
</refsynopsisdiv>
3636

@@ -166,7 +166,7 @@ ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="
166166
</varlistentry>
167167

168168
<varlistentry>
169-
<term><replaceable class="parameter">funcname</replaceable></term>
169+
<term><replaceable class="parameter">function_name</replaceable></term>
170170
<listitem>
171171
<para>
172172
The name (optionally schema-qualified) of a function that is an
@@ -176,7 +176,7 @@ ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="
176176
</varlistentry>
177177

178178
<varlistentry>
179-
<term><replaceable class="parameter">argument_types</replaceable></term>
179+
<term><replaceable class="parameter">argument_type</replaceable></term>
180180
<listitem>
181181
<para>
182182
The parameter data type(s) of the function.
@@ -185,7 +185,7 @@ ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="
185185
</varlistentry>
186186

187187
<varlistentry>
188-
<term><replaceable class="parameter">newname</replaceable></term>
188+
<term><replaceable class="parameter">new_name</replaceable></term>
189189
<listitem>
190190
<para>
191191
The new name of the operator family.
@@ -194,7 +194,7 @@ ALTER OPERATOR FAMILY <replaceable>name</replaceable> USING <replaceable class="
194194
</varlistentry>
195195

196196
<varlistentry>
197-
<term><replaceable class="parameter">newowner</replaceable></term>
197+
<term><replaceable class="parameter">new_owner</replaceable></term>
198198
<listitem>
199199
<para>
200200
The new owner of the operator family.

‎doc/src/sgml/ref/alter_role.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_role.sgml,v 1.13 2009/09/18 05:00:41 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_role.sgml,v 1.14 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -35,7 +35,7 @@ ALTER ROLE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replace
3535
| [ ENCRYPTED | UNENCRYPTED ] PASSWORD '<replaceable class="PARAMETER">password</replaceable>'
3636
| VALID UNTIL '<replaceable class="PARAMETER">timestamp</replaceable>'
3737

38-
ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
38+
ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>new_name</replaceable>
3939

4040
ALTER ROLE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
4141
ALTER ROLE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> FROM CURRENT
@@ -137,7 +137,7 @@ ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RESET ALL
137137
</varlistentry>
138138

139139
<varlistentry>
140-
<term><replaceable>newname</replaceable></term>
140+
<term><replaceable>new_name</replaceable></term>
141141
<listitem>
142142
<para>
143143
The new name of the role.

‎doc/src/sgml/ref/alter_schema.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_schema.sgml,v 1.10 2008/11/14 10:22:45 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_schema.sgml,v 1.11 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,8 +21,8 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER SCHEMA <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
25-
ALTER SCHEMA <replaceable>name</replaceable> OWNER TO <replaceable>newowner</replaceable>
24+
ALTER SCHEMA <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable>
25+
ALTER SCHEMA <replaceable>name</replaceable> OWNER TO <replaceable>new_owner</replaceable>
2626
</synopsis>
2727
</refsynopsisdiv>
2828

@@ -58,7 +58,7 @@ ALTER SCHEMA <replaceable>name</replaceable> OWNER TO <replaceable>newowner</rep
5858
</varlistentry>
5959

6060
<varlistentry>
61-
<term><replaceable>newname</replaceable></term>
61+
<term><replaceable>new_name</replaceable></term>
6262
<listitem>
6363
<para>
6464
The new name of the schema. The new name cannot
@@ -69,7 +69,7 @@ ALTER SCHEMA <replaceable>name</replaceable> OWNER TO <replaceable>newowner</rep
6969
</varlistentry>
7070

7171
<varlistentry>
72-
<term><replaceable class="parameter">newowner</replaceable></term>
72+
<term><replaceable class="parameter">new_owner</replaceable></term>
7373
<listitem>
7474
<para>
7575
The new owner of the schema.

‎doc/src/sgml/ref/alter_server.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_server.sgml,v 1.2 2009/06/19 15:28:25 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_server.sgml,v 1.3 2009/09/19 10:23:26 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -21,9 +21,9 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
ALTER SERVER <replaceable class="parameter">servername</replaceable> [ VERSION 'newversion' ]
24+
ALTER SERVER <replaceable class="parameter">server_name</replaceable> [ VERSION '<replaceable class="parameter">new_version</replaceable>' ]
2525
[ OPTIONS ( [ ADD | SET | DROP ] <replaceable class="PARAMETER">option</replaceable> ['<replaceable class="PARAMETER">value</replaceable>'] [, ... ] ) ]
26-
ALTER SERVER <replaceable class="PARAMETER">servername</replaceable> OWNER TO <replaceable>new_owner</replaceable>
26+
ALTER SERVER <replaceable class="PARAMETER">server_name</replaceable> OWNER TO <replaceable>new_owner</replaceable>
2727
</synopsis>
2828
</refsynopsisdiv>
2929

@@ -52,7 +52,7 @@ ALTER SERVER <replaceable class="PARAMETER">servername</replaceable> OWNER TO <r
5252

5353
<variablelist>
5454
<varlistentry>
55-
<term><replaceable class="parameter">servername</replaceable></term>
55+
<term><replaceable class="parameter">server_name</replaceable></term>
5656
<listitem>
5757
<para>
5858
The name of an existing server.
@@ -61,7 +61,7 @@ ALTER SERVER <replaceable class="PARAMETER">servername</replaceable> OWNER TO <r
6161
</varlistentry>
6262

6363
<varlistentry>
64-
<term><replaceable class="parameter">serverversion</replaceable></term>
64+
<term><replaceable class="parameter">new_version</replaceable></term>
6565
<listitem>
6666
<para>
6767
New server version.

0 commit comments

Comments
 (0)