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

Commit1715ff1

Browse files
committed
doc: Fix for too many brackets in command synopses on man pages
The default for the choice attribute of the <arg> element is "opt",which would normally put the argument inside brackets. But the DSSSLstylesheets contain a hack that treats <arg> directly inside <group>specially, so that <group><arg>-x</arg><arg>-y</arg></group> comes outas [ -x | -y ] rather than [ [-x] | [-y] ], which it would technicallybe. But when building man pages, this doesn't work, and so thecommand synopses on the man pages contain lots of extra brackets.By putting choice="opt" or choice="plain" explicitly on every <arg>and <group> element, we avoid any toolchain dependencies like that,and it also makes it clearer in the source code what is meant.In passing, make some small corrections in the documentation aboutwhich arguments are really optional or not.
1 parentebcaa5f commit1715ff1

16 files changed

+101
-101
lines changed

‎doc/src/sgml/ref/clusterdb.sgml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ PostgreSQL documentation
2323
<cmdsynopsis>
2424
<command>clusterdb</command>
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
26-
<group><arg><option>--verbose</option></arg><arg><option>-v</option></arg></group>
27-
<arg><group choice="plain"><arg><option>--table</option></arg><arg><option>-t</option></arg></group> <replaceable>table</replaceable> </arg>
28-
<arg><replaceable>dbname</replaceable></arg>
26+
<group choice="opt"><arg choice="plain"><option>--verbose</option></arg><arg choice="plain"><option>-v</option></arg></group>
27+
<arg choice="opt"><group choice="plain"><arg choice="plain"><option>--table</option></arg><arg choice="plain"><option>-t</option></arg></group> <replaceable>table</replaceable> </arg>
28+
<arg choice="opt"><replaceable>dbname</replaceable></arg>
2929
</cmdsynopsis>
3030

3131
<cmdsynopsis>
3232
<command>clusterdb</command>
3333
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
34-
<group><arg><option>--verbose</option></arg><arg><option>-v</option></arg></group>
35-
<group><arg><option>--all</option></arg><arg><option>-a</option></arg></group>
34+
<group choice="opt"><arg choice="plain"><option>--verbose</option></arg><arg choice="plain"><option>-v</option></arg></group>
35+
<group choice="plain"><arg choice="plain"><option>--all</option></arg><arg choice="plain"><option>-a</option></arg></group>
3636
</cmdsynopsis>
3737
</refsynopsisdiv>
3838

‎doc/src/sgml/ref/createdb.sgml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ PostgreSQL documentation
2424
<command>createdb</command>
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg rep="repeat"><replaceable>option</replaceable></arg>
27-
<arg><replaceable>dbname</replaceable></arg>
28-
<arg><replaceable>description</replaceable></arg>
27+
<arg choice="opt"><replaceable>dbname</replaceable>
28+
<arg choice="opt"><replaceable>description</replaceable></arg></arg>
2929
</cmdsynopsis>
3030
</refsynopsisdiv>
3131

‎doc/src/sgml/ref/createlang.sgml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ PostgreSQL documentation
2424
<command>createlang</command>
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg choice="plain"><replaceable>langname</replaceable></arg>
27-
<arg><replaceable>dbname</replaceable></arg>
27+
<arg choice="opt"><replaceable>dbname</replaceable></arg>
2828
</cmdsynopsis>
2929

3030
<cmdsynopsis>
3131
<command>createlang</command>
3232
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
33-
<group choice="plain"><arg><option>--list</option></arg><arg><option>-l</option></arg></group>
34-
<arg choice="plain"><replaceable>dbname</replaceable></arg>
33+
<group choice="plain"><arg choice="plain"><option>--list</option></arg><arg choice="plain"><option>-l</option></arg></group>
34+
<arg choice="opt"><replaceable>dbname</replaceable></arg>
3535
</cmdsynopsis>
3636
</refsynopsisdiv>
3737

‎doc/src/sgml/ref/createuser.sgml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ PostgreSQL documentation
2424
<command>createuser</command>
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg rep="repeat"><replaceable>option</replaceable></arg>
27-
<arg><replaceable>username</replaceable></arg>
27+
<arg choice="opt"><replaceable>username</replaceable></arg>
2828
</cmdsynopsis>
2929
</refsynopsisdiv>
3030

‎doc/src/sgml/ref/droplang.sgml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ PostgreSQL documentation
2424
<command>droplang</command>
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg choice="plain"><replaceable>langname</replaceable></arg>
27-
<arg><replaceable>dbname</replaceable></arg>
27+
<arg choice="opt"><replaceable>dbname</replaceable></arg>
2828
</cmdsynopsis>
2929

3030
<cmdsynopsis>
3131
<command>droplang</command>
3232
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
33-
<group choice="plain"><arg><option>--list</option></arg><arg><option>-l</option></arg></group>
34-
<arg choice="plain"><replaceable>dbname</replaceable></arg>
33+
<group choice="plain"><arg choice="plain"><option>--list</option></arg><arg choice="plain"><option>-l</option></arg></group>
34+
<arg choice="opt"><replaceable>dbname</replaceable></arg>
3535
</cmdsynopsis>
3636
</refsynopsisdiv>
3737

‎doc/src/sgml/ref/dropuser.sgml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ PostgreSQL documentation
2424
<command>dropuser</command>
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg rep="repeat"><replaceable>option</replaceable></arg>
27-
<arg><replaceable>username</replaceable></arg>
27+
<arg choice="opt"><replaceable>username</replaceable></arg>
2828
</cmdsynopsis>
2929
</refsynopsisdiv>
3030

‎doc/src/sgml/ref/initdb.sgml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ PostgreSQL documentation
2525
<arg rep="repeat"><replaceable>option</replaceable></arg>
2626
<group choice="plain">
2727
<group choice="opt">
28-
<arg><option>--pgdata</option></arg>
29-
<arg><option>-D</option></arg>
28+
<arg choice="plain"><option>--pgdata</option></arg>
29+
<arg choice="plain"><option>-D</option></arg>
3030
</group>
3131
<replaceable> directory</replaceable>
3232
</group>

‎doc/src/sgml/ref/pg_controldata.sgml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>pg_controldata</command>
25-
<arg><replaceable class="parameter">option</replaceable></arg>
26-
<arg><replaceable class="parameter">datadir</replaceable></arg>
25+
<arg choice="opt"><replaceable class="parameter">option</replaceable></arg>
26+
<arg choice="opt"><replaceable class="parameter">datadir</replaceable></arg>
2727
</cmdsynopsis>
2828
</refsynopsisdiv>
2929

‎doc/src/sgml/ref/pg_ctl-ref.sgml‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -23,76 +23,76 @@ PostgreSQL documentation
2323
<cmdsynopsis>
2424
<command>pg_ctl</command>
2525
<arg choice="plain"><option>init[db]</option></arg>
26-
<arg><option>-s</option></arg>
27-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
28-
<arg><option>-o</option> <replaceable>initdb-options</replaceable></arg>
26+
<arg choice="opt"><option>-s</option></arg>
27+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
28+
<arg choice="opt"><option>-o</option> <replaceable>initdb-options</replaceable></arg>
2929
</cmdsynopsis>
3030

3131
<cmdsynopsis>
3232
<command>pg_ctl</command>
3333
<arg choice="plain"><option>start</option></arg>
34-
<arg><option>-w</option></arg>
35-
<arg><option>-t</option> <replaceable>seconds</replaceable></arg>
36-
<arg><option>-s</option></arg>
37-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
38-
<arg><option>-l</option> <replaceable>filename</replaceable></arg>
39-
<arg><option>-o</option> <replaceable>options</replaceable></arg>
40-
<arg><option>-p</option> <replaceable>path</replaceable></arg>
41-
<arg><option>-c</option></arg>
34+
<arg choice="opt"><option>-w</option></arg>
35+
<arg choice="opt"><option>-t</option> <replaceable>seconds</replaceable></arg>
36+
<arg choice="opt"><option>-s</option></arg>
37+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
38+
<arg choice="opt"><option>-l</option> <replaceable>filename</replaceable></arg>
39+
<arg choice="opt"><option>-o</option> <replaceable>options</replaceable></arg>
40+
<arg choice="opt"><option>-p</option> <replaceable>path</replaceable></arg>
41+
<arg choice="opt"><option>-c</option></arg>
4242
</cmdsynopsis>
4343

4444
<cmdsynopsis>
4545
<command>pg_ctl</command>
4646
<arg choice="plain"><option>stop</option></arg>
47-
<arg><option>-W</option></arg>
48-
<arg><option>-t</option> <replaceable>seconds</replaceable></arg>
49-
<arg><option>-s</option></arg>
50-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
51-
<arg><option>-m</option>
47+
<arg choice="opt"><option>-W</option></arg>
48+
<arg choice="opt"><option>-t</option> <replaceable>seconds</replaceable></arg>
49+
<arg choice="opt"><option>-s</option></arg>
50+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
51+
<arg choice="opt"><option>-m</option>
5252
<group choice="plain">
53-
<arg><option>s[mart]</option></arg>
54-
<arg><option>f[ast]</option></arg>
55-
<arg><option>i[mmediate]</option></arg>
53+
<arg choice="plain"><option>s[mart]</option></arg>
54+
<arg choice="plain"><option>f[ast]</option></arg>
55+
<arg choice="plain"><option>i[mmediate]</option></arg>
5656
</group>
5757
</arg>
5858
</cmdsynopsis>
5959

6060
<cmdsynopsis>
6161
<command>pg_ctl</command>
6262
<arg choice="plain"><option>restart</option></arg>
63-
<arg><option>-w</option></arg>
64-
<arg><option>-t</option> <replaceable>seconds</replaceable></arg>
65-
<arg><option>-s</option></arg>
66-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
67-
<arg><option>-c</option></arg>
68-
<arg><option>-m</option>
63+
<arg choice="opt"><option>-w</option></arg>
64+
<arg choice="opt"><option>-t</option> <replaceable>seconds</replaceable></arg>
65+
<arg choice="opt"><option>-s</option></arg>
66+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
67+
<arg choice="opt"><option>-c</option></arg>
68+
<arg choice="opt"><option>-m</option>
6969
<group choice="plain">
70-
<arg><option>s[mart]</option></arg>
71-
<arg><option>f[ast]</option></arg>
72-
<arg><option>i[mmediate]</option></arg>
70+
<arg choice="plain"><option>s[mart]</option></arg>
71+
<arg choice="plain"><option>f[ast]</option></arg>
72+
<arg choice="plain"><option>i[mmediate]</option></arg>
7373
</group>
7474
</arg>
75-
<arg><option>-o</option> <replaceable>options</replaceable></arg>
75+
<arg choice="opt"><option>-o</option> <replaceable>options</replaceable></arg>
7676
</cmdsynopsis>
7777

7878
<cmdsynopsis>
7979
<command>pg_ctl</command>
8080
<arg choice="plain"><option>reload</option></arg>
81-
<arg><option>-s</option></arg>
82-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
81+
<arg choice="opt"><option>-s</option></arg>
82+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
8383
</cmdsynopsis>
8484

8585
<cmdsynopsis>
8686
<command>pg_ctl</command>
8787
<arg choice="plain"><option>status</option></arg>
88-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
88+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
8989
</cmdsynopsis>
9090

9191
<cmdsynopsis>
9292
<command>pg_ctl</command>
9393
<arg choice="plain"><option>promote</option></arg>
94-
<arg><option>-s</option></arg>
95-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
94+
<arg choice="opt"><option>-s</option></arg>
95+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
9696
</cmdsynopsis>
9797

9898
<cmdsynopsis>
@@ -105,26 +105,26 @@ PostgreSQL documentation
105105
<cmdsynopsis>
106106
<command>pg_ctl</command>
107107
<arg choice="plain"><option>register</option></arg>
108-
<arg><option>-N</option> <replaceable>servicename</replaceable></arg>
109-
<arg><option>-U</option> <replaceable>username</replaceable></arg>
110-
<arg><option>-P</option> <replaceable>password</replaceable></arg>
111-
<arg><option>-D</option> <replaceable>datadir</replaceable></arg>
112-
<arg><option>-S</option>
108+
<arg choice="opt"><option>-N</option> <replaceable>servicename</replaceable></arg>
109+
<arg choice="opt"><option>-U</option> <replaceable>username</replaceable></arg>
110+
<arg choice="opt"><option>-P</option> <replaceable>password</replaceable></arg>
111+
<arg choice="opt"><option>-D</option> <replaceable>datadir</replaceable></arg>
112+
<arg choice="opt"><option>-S</option>
113113
<group choice="plain">
114-
<arg><option>a[uto]</option></arg>
115-
<arg><option>d[emand]</option></arg>
114+
<arg choice="plain"><option>a[uto]</option></arg>
115+
<arg choice="plain"><option>d[emand]</option></arg>
116116
</group>
117117
</arg>
118-
<arg><option>-w</option></arg>
119-
<arg><option>-t</option> <replaceable>seconds</replaceable></arg>
120-
<arg><option>-s</option></arg>
121-
<arg><option>-o</option> <replaceable>options</replaceable></arg>
118+
<arg choice="opt"><option>-w</option></arg>
119+
<arg choice="opt"><option>-t</option> <replaceable>seconds</replaceable></arg>
120+
<arg choice="opt"><option>-s</option></arg>
121+
<arg choice="opt"><option>-o</option> <replaceable>options</replaceable></arg>
122122
</cmdsynopsis>
123123

124124
<cmdsynopsis>
125125
<command>pg_ctl</command>
126126
<arg choice="plain"><option>unregister</option></arg>
127-
<arg><option>-N</option> <replaceable>servicename</replaceable></arg>
127+
<arg choice="opt"><option>-N</option> <replaceable>servicename</replaceable></arg>
128128
</cmdsynopsis>
129129
</refsynopsisdiv>
130130

‎doc/src/sgml/ref/pg_dump.sgml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ PostgreSQL documentation
2727
<command>pg_dump</command>
2828
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2929
<arg rep="repeat"><replaceable>option</replaceable></arg>
30-
<arg><replaceable>dbname</replaceable></arg>
30+
<arg choice="opt"><replaceable>dbname</replaceable></arg>
3131
</cmdsynopsis>
3232
</refsynopsisdiv>
3333

0 commit comments

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