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.
5 years ago · a02b8bdd98
parent f4c88ce1a2
commit a02b8bdd98
19 changed files with 24 additions and 50 deletions
--- a/doc/src/sgml/ref/alter_collation.sgml
+++ b/doc/src/sgml/ref/alter_collation.sgml
@ -149,8 +149,7 @@ SELECT pg_describe_object(refclassid, refobjid, refobjsubid) AS "Collation",
       ON refclassid = 'pg_collation'::regclass AND refobjid = c.oid
  WHERE c.collversion <> pg_collation_actual_version(c.oid)
  ORDER BY 1, 2;
-]]></programlisting>
-  </para>
+]]></programlisting></para>
 </refsect1>

 <refsect1>
--- a/doc/src/sgml/ref/alter_subscription.sgml
+++ b/doc/src/sgml/ref/alter_subscription.sgml
@ -133,8 +133,7 @@ ALTER SUBSCRIPTION <replaceable class="parameter">name</replaceable> RENAME TO <
         </para>
        </listitem>
       </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
    </listitem>
   </varlistentry>

--- a/doc/src/sgml/ref/alter_type.sgml
+++ b/doc/src/sgml/ref/alter_type.sgml
@ -463,8 +463,7 @@ ALTER TYPE mytype SET (
    SEND = mytypesend,
    RECEIVE = mytyperecv
 );
-</programlisting>
-  </para>
+</programlisting></para>
 </refsect1>

 <refsect1>
--- a/doc/src/sgml/ref/alter_view.sgml
+++ b/doc/src/sgml/ref/alter_view.sgml
@ -161,8 +161,7 @@ ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RESET
         </para>
        </listitem>
       </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
    </listitem>
   </varlistentry>
  </variablelist>
--- a/doc/src/sgml/ref/create_extension.sgml
+++ b/doc/src/sgml/ref/create_extension.sgml
@ -191,8 +191,7 @@ CREATE EXTENSION [ IF NOT EXISTS ] <replaceable class="parameter">extension_name
   current database:
 <programlisting>
 CREATE EXTENSION hstore;
-</programlisting>
-  </para>
+</programlisting></para>
 </refsect1>

 <refsect1>
--- a/doc/src/sgml/ref/create_language.sgml
+++ b/doc/src/sgml/ref/create_language.sgml
@ -229,8 +229,7 @@ CREATE LANGUAGE plsample
   and users would do this to install the extension:
 <programlisting>
 CREATE EXTENSION plsample;
-</programlisting>
-  </para>
+</programlisting></para>
 </refsect1>

 <refsect1 id="sql-createlanguage-compat">
--- a/doc/src/sgml/ref/create_publication.sgml
+++ b/doc/src/sgml/ref/create_publication.sgml
@ -25,7 +25,6 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
    [ FOR TABLE [ ONLY ] <replaceable class="parameter">table_name</replaceable> [ * ] [, ...]
      | FOR ALL TABLES ]
    [ WITH ( <replaceable class="parameter">publication_parameter</replaceable> [= <replaceable class="parameter">value</replaceable>] [, ... ] ) ]
-
 </synopsis>
 </refsynopsisdiv>

@ -143,9 +142,7 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
         </para>
        </listitem>
       </varlistentry>
-      </variablelist>
-
-     </para>
+      </variablelist></para>
    </listitem>
   </varlistentry>

--- a/doc/src/sgml/ref/create_subscription.sgml
+++ b/doc/src/sgml/ref/create_subscription.sgml
@ -206,8 +206,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
         </para>
        </listitem>
       </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
    </listitem>
   </varlistentry>
  </variablelist>
--- a/doc/src/sgml/ref/create_view.sgml
+++ b/doc/src/sgml/ref/create_view.sgml
@ -152,8 +152,7 @@ CREATE VIEW [ <replaceable>schema</replaceable> . ] <replaceable>view_name</repl
         </para>
        </listitem>
       </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
    </listitem>
   </varlistentry>

--- a/doc/src/sgml/ref/drop_function.sgml
+++ b/doc/src/sgml/ref/drop_function.sgml
@ -175,8 +175,7 @@ DROP FUNCTION update_employee_salaries();
    <listitem>
     <para>The ability to specify argument modes and names</para>
    </listitem>
-   </itemizedlist>
-  </para>
+   </itemizedlist></para>
 </refsect1>

 <refsect1>
--- a/doc/src/sgml/ref/drop_procedure.sgml
+++ b/doc/src/sgml/ref/drop_procedure.sgml
@ -144,8 +144,7 @@ DROP PROCEDURE do_db_maintenance();
    <listitem>
     <para>The ability to specify argument modes and names</para>
    </listitem>
-   </itemizedlist>
-  </para>
+   </itemizedlist></para>
 </refsect1>

 <refsect1>
--- a/doc/src/sgml/ref/drop_routine.sgml
+++ b/doc/src/sgml/ref/drop_routine.sgml
@ -72,8 +72,7 @@ DROP ROUTINE foo(integer);
    <listitem>
     <para>Aggregate functions are an extension.</para>
    </listitem>
-   </itemizedlist>
-  </para>
+   </itemizedlist></para>
 </refsect1>

 <refsect1>
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@ -341,8 +341,7 @@ PostgreSQL documentation
           </para>
          </listitem>
         </varlistentry>
-        </variablelist>
-       </para>
+        </variablelist></para>
      </listitem>
     </varlistentry>

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

 <refsect1>
--- a/doc/src/sgml/ref/pg_verifybackup.sgml
+++ b/doc/src/sgml/ref/pg_verifybackup.sgml
@ -273,8 +273,7 @@ PostgreSQL documentation
 <prompt>$</prompt> <userinput>pg_basebackup -h mydbserver -D /usr/local/pgsql/data</userinput>
 <prompt>$</prompt> <userinput>edit /usr/local/pgsql/data/note.to.self</userinput>
 <prompt>$</prompt> <userinput>pg_verifybackup --ignore=note.to.self --skip-checksums /usr/local/pgsql/data</userinput>
-</screen>
-  </para>
+</screen></para>

 </refsect1>

--- a/doc/src/sgml/ref/pgbench.sgml
+++ b/doc/src/sgml/ref/pgbench.sgml
@ -251,8 +251,7 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
           </para>
          </listitem>
         </varlistentry>
-        </variablelist>
-       </para>
+        </variablelist></para>
      </listitem>
     </varlistentry>

@ -1104,8 +1103,7 @@ UPDATE pgbench_accounts
 SELECT 1 \;
 SELECT 2 AS two, 3 AS three \gset p_
 SELECT 4 AS four \; SELECT 5 AS five \aset
-</programlisting>
-     </para>
+</programlisting></para>
    </listitem>
   </varlistentry>

--- a/doc/src/sgml/ref/pgupgrade.sgml
+++ b/doc/src/sgml/ref/pgupgrade.sgml
@ -726,11 +726,9 @@ psql --username=postgres --file=script.sql postgres
          </para>
         </listitem>

-        </itemizedlist>
-       </para>
+        </itemizedlist></para>
      </listitem>
-     </itemizedlist>
-    </para>
+     </itemizedlist></para>
   </step>
  </procedure>

--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@ -146,8 +146,7 @@ psql &lt;&lt;EOF
 \x
 SELECT * FROM foo;
 EOF
-</programlisting>
-      </para>
+</programlisting></para>
      </listitem>
    </varlistentry>

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

 </refsect1>

--- a/doc/src/sgml/ref/select.sgml
+++ b/doc/src/sgml/ref/select.sgml
@ -1413,7 +1413,7 @@ SELECT name FROM distributors ORDER BY code;
 LIMIT { <replaceable class="parameter">count</replaceable> | ALL }
 OFFSET <replaceable class="parameter">start</replaceable>
 </synopsis>
-    <replaceable class="parameter">count</replaceable> specifies the
+    The parameter <replaceable class="parameter">count</replaceable> specifies the
    maximum number of rows to return, while <replaceable
    class="parameter">start</replaceable> specifies the number of rows
    to skip before starting to return rows.  When both are specified,
@ -1941,8 +1941,7 @@ SELECT 2+2;
    following query is invalid:
 <programlisting>
 SELECT distributors.* WHERE distributors.name = 'Westward';
-</programlisting>
-    <productname>PostgreSQL</productname> releases prior to
+</programlisting><productname>PostgreSQL</productname> releases prior to
    8.1 would accept queries of this form, and add an implicit entry
    to the query's <literal>FROM</literal> clause for each table
    referenced by the query. This is no longer allowed.
--- a/doc/src/sgml/spi.sgml
+++ b/doc/src/sgml/spi.sgml
@ -332,7 +332,7 @@ typedef struct SPITupleTable
    SubTransactionId subid;     /* subxact in which tuptable was created */
 } SPITupleTable;
 </programlisting>
-   <structfield>tupdesc</structfield>,
+   The fields <structfield>tupdesc</structfield>,
   <structfield>vals</structfield>, and
   <structfield>numvals</structfield>
   can be used by SPI callers; the remaining fields are internal.