From: Peter Eisentraut <peter_e@gmx.net>
Date: Sat, 25 Sep 2010 06:57:09 +0000 (+0300)
Subject: Fix man page markup for <cmdsynopsis> with multiple variants
X-Git-Tag: REL9_1_ALPHA2~151
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=635de8365f0299cfa2db24c56abcfccb65d020f0;p=postgresql

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
---

diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml
index 4a3a339557..f57f0b3ddd 100644
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
@@ -26,7 +26,9 @@ PostgreSQL documentation
    <group><arg>--verbose</arg><arg>-v</arg></group>
    <arg>--table | -t <replaceable>table</replaceable> </arg>
    <arg><replaceable>dbname</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
    <command>clusterdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <group><arg>--verbose</arg><arg>-v</arg></group>
diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml
index 5db5e6cd41..e157396de7 100644
--- a/doc/src/sgml/ref/createlang.sgml
+++ b/doc/src/sgml/ref/createlang.sgml
@@ -25,7 +25,9 @@ PostgreSQL documentation
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <arg choice="plain"><replaceable>langname</replaceable></arg>
    <arg><replaceable>dbname</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
    <command>createlang</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml
index a92cd932eb..f0e2bf9594 100644
--- a/doc/src/sgml/ref/droplang.sgml
+++ b/doc/src/sgml/ref/droplang.sgml
@@ -25,7 +25,9 @@ PostgreSQL documentation
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <arg choice="plain"><replaceable>langname</replaceable></arg>
    <arg><replaceable>dbname</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
    <command>droplang</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml
index 7494b5debb..df3794f8cd 100644
--- a/doc/src/sgml/ref/pg_ctl-ref.sgml
+++ b/doc/src/sgml/ref/pg_ctl-ref.sgml
@@ -21,14 +21,14 @@ PostgreSQL documentation
 
  <refsynopsisdiv>
   <cmdsynopsis>
-
    <command>pg_ctl</command>
    <arg choice="plain">init[db]</arg>
    <arg>-s</arg>
    <arg>-D <replaceable>datadir</replaceable></arg>
    <arg>-o <replaceable>options</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">start</arg>
    <arg>-w</arg>
@@ -39,8 +39,9 @@ PostgreSQL documentation
    <arg>-o <replaceable>options</replaceable></arg>
    <arg>-p <replaceable>path</replaceable></arg>
    <arg>-c</arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">stop</arg>
    <arg>-W</arg>
@@ -54,8 +55,9 @@ PostgreSQL documentation
        <arg>i[mmediate]</arg>
      </group>
    </arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">restart</arg>
    <arg>-w</arg>
@@ -71,25 +73,29 @@ PostgreSQL documentation
      </group>
    </arg>
    <arg>-o <replaceable>options</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">reload</arg>
    <arg>-s</arg>
    <arg>-D <replaceable>datadir</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">status</arg>
    <arg>-D <replaceable>datadir</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">kill</arg>
    <arg><replaceable>signal_name</replaceable></arg>
    <arg><replaceable>process_id</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">register</arg>
    <arg>-N <replaceable>servicename</replaceable></arg>
@@ -99,12 +105,12 @@ PostgreSQL documentation
    <arg>-w</arg>
    <arg>-t <replaceable>seconds</replaceable></arg>
    <arg>-o <replaceable>options</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
 
+  <cmdsynopsis>
    <command>pg_ctl</command>
    <arg choice="plain">unregister</arg>
    <arg>-N <replaceable>servicename</replaceable></arg>
-
   </cmdsynopsis>
  </refsynopsisdiv>
 
diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml
index fb680ece70..ddbf0ca65f 100644
--- a/doc/src/sgml/ref/reindexdb.sgml
+++ b/doc/src/sgml/ref/reindexdb.sgml
@@ -26,11 +26,15 @@ PostgreSQL documentation
    <arg>--table | -t <replaceable>table</replaceable> </arg>
    <arg>--index | -i <replaceable>index</replaceable> </arg>
    <arg><replaceable>dbname</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
    <command>reindexdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <arg>--all | -a</arg>
-   <sbr>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
    <command>reindexdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <arg>--system | -s</arg>
diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
index 43e6d5effc..b4833f1252 100644
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -32,7 +32,9 @@ PostgreSQL documentation
     <arg>( <replaceable class="parameter">column</replaceable> [,...] )</arg>
    </arg>
    <arg><replaceable>dbname</replaceable></arg>
-   <sbr>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
    <command>vacuumdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
    <group><arg>--full</arg><arg>-f</arg></group>