Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 635de83

Browse files
committed
Fix man page markup for <cmdsynopsis> with multiple variants
Command synopses using <cmdsynopsis> with multiple variants previously used <sbr> to break lines between variants. The new man page toolchain introduced in 9.0 makes a mess out of that, and that markup was probably wrong all along, because <sbr> is supposed to break lines within a synopsis, not between them. So fix that by using multiple <cmdsynopsis> elements inside <refsynopsisdiv>. backpatched to 9.0
1 parent 12679b8 commit 635de83

File tree

6 files changed

+34
-16
lines changed

6 files changed

+34
-16
lines changed

doc/src/sgml/ref/clusterdb.sgml

+3-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ PostgreSQL documentation
2626
<group><arg>--verbose</arg><arg>-v</arg></group>
2727
<arg>--table | -t <replaceable>table</replaceable> </arg>
2828
<arg><replaceable>dbname</replaceable></arg>
29-
<sbr>
29+
</cmdsynopsis>
30+
31+
<cmdsynopsis>
3032
<command>clusterdb</command>
3133
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
3234
<group><arg>--verbose</arg><arg>-v</arg></group>

doc/src/sgml/ref/createlang.sgml

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ PostgreSQL documentation
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg choice="plain"><replaceable>langname</replaceable></arg>
2727
<arg><replaceable>dbname</replaceable></arg>
28-
<sbr>
28+
</cmdsynopsis>
29+
30+
<cmdsynopsis>
2931
<command>createlang</command>
3032
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
3133
<group choice="plain"><arg>--list</arg><arg>-l</arg></group>

doc/src/sgml/ref/droplang.sgml

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ PostgreSQL documentation
2525
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2626
<arg choice="plain"><replaceable>langname</replaceable></arg>
2727
<arg><replaceable>dbname</replaceable></arg>
28-
<sbr>
28+
</cmdsynopsis>
29+
30+
<cmdsynopsis>
2931
<command>droplang</command>
3032
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
3133
<group choice="plain"><arg>--list</arg><arg>-l</arg></group>

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

+16-10
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ PostgreSQL documentation
2121

2222
<refsynopsisdiv>
2323
<cmdsynopsis>
24-
2524
<command>pg_ctl</command>
2625
<arg choice="plain">init[db]</arg>
2726
<arg>-s</arg>
2827
<arg>-D <replaceable>datadir</replaceable></arg>
2928
<arg>-o <replaceable>options</replaceable></arg>
30-
<sbr>
29+
</cmdsynopsis>
3130

31+
<cmdsynopsis>
3232
<command>pg_ctl</command>
3333
<arg choice="plain">start</arg>
3434
<arg>-w</arg>
@@ -39,8 +39,9 @@ PostgreSQL documentation
3939
<arg>-o <replaceable>options</replaceable></arg>
4040
<arg>-p <replaceable>path</replaceable></arg>
4141
<arg>-c</arg>
42-
<sbr>
42+
</cmdsynopsis>
4343

44+
<cmdsynopsis>
4445
<command>pg_ctl</command>
4546
<arg choice="plain">stop</arg>
4647
<arg>-W</arg>
@@ -54,8 +55,9 @@ PostgreSQL documentation
5455
<arg>i[mmediate]</arg>
5556
</group>
5657
</arg>
57-
<sbr>
58+
</cmdsynopsis>
5859

60+
<cmdsynopsis>
5961
<command>pg_ctl</command>
6062
<arg choice="plain">restart</arg>
6163
<arg>-w</arg>
@@ -71,25 +73,29 @@ PostgreSQL documentation
7173
</group>
7274
</arg>
7375
<arg>-o <replaceable>options</replaceable></arg>
74-
<sbr>
76+
</cmdsynopsis>
7577

78+
<cmdsynopsis>
7679
<command>pg_ctl</command>
7780
<arg choice="plain">reload</arg>
7881
<arg>-s</arg>
7982
<arg>-D <replaceable>datadir</replaceable></arg>
80-
<sbr>
83+
</cmdsynopsis>
8184

85+
<cmdsynopsis>
8286
<command>pg_ctl</command>
8387
<arg choice="plain">status</arg>
8488
<arg>-D <replaceable>datadir</replaceable></arg>
85-
<sbr>
89+
</cmdsynopsis>
8690

91+
<cmdsynopsis>
8792
<command>pg_ctl</command>
8893
<arg choice="plain">kill</arg>
8994
<arg><replaceable>signal_name</replaceable></arg>
9095
<arg><replaceable>process_id</replaceable></arg>
91-
<sbr>
96+
</cmdsynopsis>
9297

98+
<cmdsynopsis>
9399
<command>pg_ctl</command>
94100
<arg choice="plain">register</arg>
95101
<arg>-N <replaceable>servicename</replaceable></arg>
@@ -99,12 +105,12 @@ PostgreSQL documentation
99105
<arg>-w</arg>
100106
<arg>-t <replaceable>seconds</replaceable></arg>
101107
<arg>-o <replaceable>options</replaceable></arg>
102-
<sbr>
108+
</cmdsynopsis>
103109

110+
<cmdsynopsis>
104111
<command>pg_ctl</command>
105112
<arg choice="plain">unregister</arg>
106113
<arg>-N <replaceable>servicename</replaceable></arg>
107-
108114
</cmdsynopsis>
109115
</refsynopsisdiv>
110116

doc/src/sgml/ref/reindexdb.sgml

+6-2
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,15 @@ PostgreSQL documentation
2626
<arg>--table | -t <replaceable>table</replaceable> </arg>
2727
<arg>--index | -i <replaceable>index</replaceable> </arg>
2828
<arg><replaceable>dbname</replaceable></arg>
29-
<sbr>
29+
</cmdsynopsis>
30+
31+
<cmdsynopsis>
3032
<command>reindexdb</command>
3133
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
3234
<arg>--all | -a</arg>
33-
<sbr>
35+
</cmdsynopsis>
36+
37+
<cmdsynopsis>
3438
<command>reindexdb</command>
3539
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
3640
<arg>--system | -s</arg>

doc/src/sgml/ref/vacuumdb.sgml

+3-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ PostgreSQL documentation
3232
<arg>( <replaceable class="parameter">column</replaceable> [,...] )</arg>
3333
</arg>
3434
<arg><replaceable>dbname</replaceable></arg>
35-
<sbr>
35+
</cmdsynopsis>
36+
37+
<cmdsynopsis>
3638
<command>vacuumdb</command>
3739
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
3840
<group><arg>--full</arg><arg>-f</arg></group>

0 commit comments

Comments
 (0)