doc: Fix man page whitespace issues
authorPeter Eisentraut <[email protected]>
Sun, 7 Jun 2020 12:54:28 +0000 (14:54 +0200)
committerPeter Eisentraut <[email protected]>
Sun, 7 Jun 2020 12:54:28 +0000 (14:54 +0200)
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.

19 files changed:
doc/src/sgml/ref/alter_collation.sgml
doc/src/sgml/ref/alter_subscription.sgml
doc/src/sgml/ref/alter_type.sgml
doc/src/sgml/ref/alter_view.sgml
doc/src/sgml/ref/create_extension.sgml
doc/src/sgml/ref/create_language.sgml
doc/src/sgml/ref/create_publication.sgml
doc/src/sgml/ref/create_subscription.sgml
doc/src/sgml/ref/create_view.sgml
doc/src/sgml/ref/drop_function.sgml
doc/src/sgml/ref/drop_procedure.sgml
doc/src/sgml/ref/drop_routine.sgml
doc/src/sgml/ref/pg_basebackup.sgml
doc/src/sgml/ref/pg_verifybackup.sgml
doc/src/sgml/ref/pgbench.sgml
doc/src/sgml/ref/pgupgrade.sgml
doc/src/sgml/ref/psql-ref.sgml
doc/src/sgml/ref/select.sgml
doc/src/sgml/spi.sgml

index 56f94627c673eee8ac5a127cc74389b85c0999c9..bee6f0dd3ca1d1e8dbd00a9b91b870117b5ee681 100644 (file)
@@ -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>
index 1b8beadbaa543eb7b84609899220babd5188e0fe..c24ace14d10c4e66e6751e03d8e683334f8bbfa1 100644 (file)
@@ -133,8 +133,7 @@ ALTER SUBSCRIPTION <replaceable class="parameter">name</replaceable> RENAME TO <
          </para>
         </listitem>
        </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
     </listitem>
    </varlistentry>
 
index e0afaf8d0b0793a358fe1822d25f698e0465a0c4..f015fcd2689b299fb1dc132ffa49e770d7e221f9 100644 (file)
@@ -463,8 +463,7 @@ ALTER TYPE mytype SET (
     SEND = mytypesend,
     RECEIVE = mytyperecv
 );
-</programlisting>
-  </para>
+</programlisting></para>
  </refsect1>
 
  <refsect1>
index 4f35061d043c48d4dc6365eea96935c6b8958805..e8d9e11e0f6f2030d66f162cc4e123690c996e0b 100644 (file)
@@ -161,8 +161,7 @@ ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RESET
          </para>
         </listitem>
        </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
     </listitem>
    </varlistentry>
   </variablelist>
index 6a21bff2f62619ccdc9f185184d334dbccaee42f..756dd193f85463e5775ba181bf8c2c19a4452689 100644 (file)
@@ -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>
index 2243ee6a6c6f574a5fd49d6df3b5cc30df460f64..44d14c0ba72556591f08d8343cd513a08aad3c68 100644 (file)
@@ -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">
index 473bfb6e56fca7ea3bfd73ca0c55bf1cfbbdb82f..ff82fbca55be2bce3bb90007a09d14fb009acbdc 100644 (file)
@@ -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>
 
index 1a90c244fbfbf8a8a7988362c120cded8d5314a3..5bbc165f70d552e94365d9f2b3bd5d6fdd8ceb52 100644 (file)
@@ -206,8 +206,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
          </para>
         </listitem>
        </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
     </listitem>
    </varlistentry>
   </variablelist>
index bad5a4eb87c9cb9dfe6c80ad71e8898cf16fb4c3..eb5591b63c73fbb04fa656d0280b2ca6689cb425 100644 (file)
@@ -152,8 +152,7 @@ CREATE VIEW [ <replaceable>schema</replaceable> . ] <replaceable>view_name</repl
          </para>
         </listitem>
        </varlistentry>
-      </variablelist>
-     </para>
+      </variablelist></para>
     </listitem>
    </varlistentry>
 
index 127fdfe419770ed016dc8d28e2d1f1a3805f7c97..d84bebc5376d84ae406b3ceaa8d30634cbbbd333 100644 (file)
@@ -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>
index fef61b66ac1b1bea7736f6080dbf6327ed1f09e6..6da266ae2dae970f3f226d0de036a618c38c2b16 100644 (file)
@@ -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>
index 5cd1a0f11eba58677253baeea2a89a60d7356543..6c50eb44a1993acfbf3ed2361981d122289b75a5 100644 (file)
@@ -72,8 +72,7 @@ DROP ROUTINE foo(integer);
     <listitem>
      <para>Aggregate functions are an extension.</para>
     </listitem>
-   </itemizedlist>
-  </para>
+   </itemizedlist></para>
  </refsect1>
 
  <refsect1>
index cf099ccbcabc4aa47935a3b705786841905e681f..db480be674abf16e0d5a776fbaeee8645be45126 100644 (file)
@@ -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>
index c2b7567c4cf4341975af1a97b995c745f515a247..44f4e67d5770744b8257e59d9da6d4d02d07e184 100644 (file)
@@ -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>
 
index aa2076de40716209746de3dfd27295e49d499b33..8e728dc0946a29cbb4eef6a3ac34139dd2a56fcf 100644 (file)
@@ -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>
 
index 905167690bcecc019bc1c0953a351a0cae243195..319d6132966aefe20c5e91339dd66182a9fca3a4 100644 (file)
@@ -726,11 +726,9 @@ psql --username=postgres --file=script.sql postgres
           </para>
          </listitem>
 
-        </itemizedlist>
-       </para>
+        </itemizedlist></para>
       </listitem>
-     </itemizedlist>
-    </para>
+     </itemizedlist></para>
    </step>
   </procedure>
 
index 62fee5a7dddd4313b3fd3710b60e90b9feb7fbef..42e862cf179fc9f5aa39f4b99b6a58a2a8431d45 100644 (file)
@@ -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>
 
index 475281dd7be61b520f0acf858340e1cccff4f1e1..b93e4ca208b1f703ce59b2d33d816d9c5b044ac9 100644 (file)
@@ -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.
index f5991b6a7a1f586d8efde51068c9094fbe6784b5..3b2a6149299f8f1f5a209a1bc81bcedce99d3d8d 100644 (file)
@@ -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.