Skip to content

Commit a02b8bd

Browse files
committed
doc: Fix man page whitespace issues
Whitespace between tags is significant, and in some cases it creates extra vertical space in man pages. The fix is either to remove some newlines or in some cases to reword slightly to avoid the awkward markup layout.
1 parent f4c88ce commit a02b8bd

19 files changed

+24
-50
lines changed

doc/src/sgml/ref/alter_collation.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,7 @@ SELECT pg_describe_object(refclassid, refobjid, refobjsubid) AS "Collation",
149149
ON refclassid = 'pg_collation'::regclass AND refobjid = c.oid
150150
WHERE c.collversion <> pg_collation_actual_version(c.oid)
151151
ORDER BY 1, 2;
152-
]]></programlisting>
153-
</para>
152+
]]></programlisting></para>
154153
</refsect1>
155154

156155
<refsect1>

doc/src/sgml/ref/alter_subscription.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,7 @@ ALTER SUBSCRIPTION <replaceable class="parameter">name</replaceable> RENAME TO <
133133
</para>
134134
</listitem>
135135
</varlistentry>
136-
</variablelist>
137-
</para>
136+
</variablelist></para>
138137
</listitem>
139138
</varlistentry>
140139

doc/src/sgml/ref/alter_type.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -463,8 +463,7 @@ ALTER TYPE mytype SET (
463463
SEND = mytypesend,
464464
RECEIVE = mytyperecv
465465
);
466-
</programlisting>
467-
</para>
466+
</programlisting></para>
468467
</refsect1>
469468

470469
<refsect1>

doc/src/sgml/ref/alter_view.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,7 @@ ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RESET
161161
</para>
162162
</listitem>
163163
</varlistentry>
164-
</variablelist>
165-
</para>
164+
</variablelist></para>
166165
</listitem>
167166
</varlistentry>
168167
</variablelist>

doc/src/sgml/ref/create_extension.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,7 @@ CREATE EXTENSION [ IF NOT EXISTS ] <replaceable class="parameter">extension_name
191191
current database:
192192
<programlisting>
193193
CREATE EXTENSION hstore;
194-
</programlisting>
195-
</para>
194+
</programlisting></para>
196195
</refsect1>
197196

198197
<refsect1>

doc/src/sgml/ref/create_language.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,7 @@ CREATE LANGUAGE plsample
229229
and users would do this to install the extension:
230230
<programlisting>
231231
CREATE EXTENSION plsample;
232-
</programlisting>
233-
</para>
232+
</programlisting></para>
234233
</refsect1>
235234

236235
<refsect1 id="sql-createlanguage-compat">

doc/src/sgml/ref/create_publication.sgml

+1-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
2525
[ FOR TABLE [ ONLY ] <replaceable class="parameter">table_name</replaceable> [ * ] [, ...]
2626
| FOR ALL TABLES ]
2727
[ WITH ( <replaceable class="parameter">publication_parameter</replaceable> [= <replaceable class="parameter">value</replaceable>] [, ... ] ) ]
28-
2928
</synopsis>
3029
</refsynopsisdiv>
3130

@@ -143,9 +142,7 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
143142
</para>
144143
</listitem>
145144
</varlistentry>
146-
</variablelist>
147-
148-
</para>
145+
</variablelist></para>
149146
</listitem>
150147
</varlistentry>
151148

doc/src/sgml/ref/create_subscription.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
206206
</para>
207207
</listitem>
208208
</varlistentry>
209-
</variablelist>
210-
</para>
209+
</variablelist></para>
211210
</listitem>
212211
</varlistentry>
213212
</variablelist>

doc/src/sgml/ref/create_view.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,7 @@ CREATE VIEW [ <replaceable>schema</replaceable> . ] <replaceable>view_name</repl
152152
</para>
153153
</listitem>
154154
</varlistentry>
155-
</variablelist>
156-
</para>
155+
</variablelist></para>
157156
</listitem>
158157
</varlistentry>
159158

doc/src/sgml/ref/drop_function.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,7 @@ DROP FUNCTION update_employee_salaries();
175175
<listitem>
176176
<para>The ability to specify argument modes and names</para>
177177
</listitem>
178-
</itemizedlist>
179-
</para>
178+
</itemizedlist></para>
180179
</refsect1>
181180

182181
<refsect1>

doc/src/sgml/ref/drop_procedure.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,7 @@ DROP PROCEDURE do_db_maintenance();
144144
<listitem>
145145
<para>The ability to specify argument modes and names</para>
146146
</listitem>
147-
</itemizedlist>
148-
</para>
147+
</itemizedlist></para>
149148
</refsect1>
150149

151150
<refsect1>

doc/src/sgml/ref/drop_routine.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ DROP ROUTINE foo(integer);
7272
<listitem>
7373
<para>Aggregate functions are an extension.</para>
7474
</listitem>
75-
</itemizedlist>
76-
</para>
75+
</itemizedlist></para>
7776
</refsect1>
7877

7978
<refsect1>

doc/src/sgml/ref/pg_basebackup.sgml

+2-4
Original file line numberDiff line numberDiff line change
@@ -341,8 +341,7 @@ PostgreSQL documentation
341341
</para>
342342
</listitem>
343343
</varlistentry>
344-
</variablelist>
345-
</para>
344+
</variablelist></para>
346345
</listitem>
347346
</varlistentry>
348347

@@ -878,8 +877,7 @@ PostgreSQL documentation
878877
to <filename>./backup/ts</filename>:
879878
<screen>
880879
<prompt>$</prompt> <userinput>pg_basebackup -D backup/data -T /opt/ts=$(pwd)/backup/ts</userinput>
881-
</screen>
882-
</para>
880+
</screen></para>
883881
</refsect1>
884882

885883
<refsect1>

doc/src/sgml/ref/pg_verifybackup.sgml

+1-2
Original file line numberDiff line numberDiff line change
@@ -273,8 +273,7 @@ PostgreSQL documentation
273273
<prompt>$</prompt> <userinput>pg_basebackup -h mydbserver -D /usr/local/pgsql/data</userinput>
274274
<prompt>$</prompt> <userinput>edit /usr/local/pgsql/data/note.to.self</userinput>
275275
<prompt>$</prompt> <userinput>pg_verifybackup --ignore=note.to.self --skip-checksums /usr/local/pgsql/data</userinput>
276-
</screen>
277-
</para>
276+
</screen></para>
278277

279278
</refsect1>
280279

doc/src/sgml/ref/pgbench.sgml

+2-4
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,7 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
251251
</para>
252252
</listitem>
253253
</varlistentry>
254-
</variablelist>
255-
</para>
254+
</variablelist></para>
256255
</listitem>
257256
</varlistentry>
258257

@@ -1104,8 +1103,7 @@ UPDATE pgbench_accounts
11041103
SELECT 1 \;
11051104
SELECT 2 AS two, 3 AS three \gset p_
11061105
SELECT 4 AS four \; SELECT 5 AS five \aset
1107-
</programlisting>
1108-
</para>
1106+
</programlisting></para>
11091107
</listitem>
11101108
</varlistentry>
11111109

doc/src/sgml/ref/pgupgrade.sgml

+2-4
Original file line numberDiff line numberDiff line change
@@ -726,11 +726,9 @@ psql --username=postgres --file=script.sql postgres
726726
</para>
727727
</listitem>
728728

729-
</itemizedlist>
730-
</para>
729+
</itemizedlist></para>
731730
</listitem>
732-
</itemizedlist>
733-
</para>
731+
</itemizedlist></para>
734732
</step>
735733
</procedure>
736734

doc/src/sgml/ref/psql-ref.sgml

+2-6
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,7 @@ psql &lt;&lt;EOF
146146
\x
147147
SELECT * FROM foo;
148148
EOF
149-
</programlisting>
150-
</para>
149+
</programlisting></para>
151150
</listitem>
152151
</varlistentry>
153152

@@ -4825,7 +4824,6 @@ peter@localhost testdb=&gt; SELECT * FROM my_table;
48254824
3 | three
48264825
4 | four
48274826
(4 rows)
4828-
48294827
</programlisting>
48304828
You can display tables in different ways by using the
48314829
<command>\pset</command> command:
@@ -4955,9 +4953,7 @@ testdb(&gt; <userinput>\crosstabview "A" "B" "AxB" ord</userinput>
49554953
2 | 202 | 204 | 206 | 208
49564954
1 | 101 | 102 | 103 | 104
49574955
(4 rows)
4958-
</programlisting>
4959-
4960-
</para>
4956+
</programlisting></para>
49614957

49624958
</refsect1>
49634959

doc/src/sgml/ref/select.sgml

+2-3
Original file line numberDiff line numberDiff line change
@@ -1413,7 +1413,7 @@ SELECT name FROM distributors ORDER BY code;
14131413
LIMIT { <replaceable class="parameter">count</replaceable> | ALL }
14141414
OFFSET <replaceable class="parameter">start</replaceable>
14151415
</synopsis>
1416-
<replaceable class="parameter">count</replaceable> specifies the
1416+
The parameter <replaceable class="parameter">count</replaceable> specifies the
14171417
maximum number of rows to return, while <replaceable
14181418
class="parameter">start</replaceable> specifies the number of rows
14191419
to skip before starting to return rows. When both are specified,
@@ -1941,8 +1941,7 @@ SELECT 2+2;
19411941
following query is invalid:
19421942
<programlisting>
19431943
SELECT distributors.* WHERE distributors.name = 'Westward';
1944-
</programlisting>
1945-
<productname>PostgreSQL</productname> releases prior to
1944+
</programlisting><productname>PostgreSQL</productname> releases prior to
19461945
8.1 would accept queries of this form, and add an implicit entry
19471946
to the query's <literal>FROM</literal> clause for each table
19481947
referenced by the query. This is no longer allowed.

doc/src/sgml/spi.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ typedef struct SPITupleTable
332332
SubTransactionId subid; /* subxact in which tuptable was created */
333333
} SPITupleTable;
334334
</programlisting>
335-
<structfield>tupdesc</structfield>,
335+
The fields <structfield>tupdesc</structfield>,
336336
<structfield>vals</structfield>, and
337337
<structfield>numvals</structfield>
338338
can be used by SPI callers; the remaining fields are internal.

0 commit comments

Comments
 (0)