From 36c8e5cd00fd600be63160b0ef9427a70ab45870 Mon Sep 17 00:00:00 2001
From: Markus Lehtonen <markus.lehtonen@linux.intel.com>
Date: Wed, 21 May 2014 10:24:21 +0300
Subject: docs: document common options in one place

Move the documentation of command line options common to all tools into
one file. This unifies the manpage documentation and should make its
maintenance easier. Also, this change adds missing options to several
manpages.

Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>
---
 docs/manpages/gbp-clone.sgml              | 11 ++----
 docs/manpages/gbp-config.sgml             | 33 +---------------
 docs/manpages/gbp-create-remote-repo.sgml | 19 ++-------
 docs/manpages/gbp-dch.sgml                | 13 ++-----
 docs/manpages/gbp-import-dsc.sgml         | 13 ++-----
 docs/manpages/gbp-import-orig.sgml        | 13 ++-----
 docs/manpages/gbp-pq.sgml                 | 38 ++----------------
 docs/manpages/gbp-pull.sgml               | 11 ++----
 docs/manpages/man.common-options.ent      | 65 +++++++++++++++++++++++++++++++
 docs/manpages/manpages.ent                |  2 +
 10 files changed, 90 insertions(+), 128 deletions(-)
 create mode 100644 docs/manpages/man.common-options.ent

diff --git a/docs/manpages/gbp-clone.sgml b/docs/manpages/gbp-clone.sgml
index 2dec88dd..20e61472 100644
--- a/docs/manpages/gbp-clone.sgml
+++ b/docs/manpages/gbp-clone.sgml
@@ -21,7 +21,7 @@
     <cmdsynopsis>
       &gbp-clone;
 
-      <arg><option>--verbose</option></arg>
+      &man.common.options.synopsis;
       <arg><option>--all</option></arg>
       <arg><option>--[no-]pristine-tar</option></arg>
       <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
@@ -43,6 +43,8 @@
     <title>OPTIONS</title>
 
     <variablelist>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--all</option>
         </term>
@@ -74,13 +76,6 @@
           <para>Git history depth, for creating shallow git clones.</para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-	<term><option>-v</option></term>
-        <listitem>
-          <para>verbose execution</para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><option>--pristine-tar</option>
         </term>
diff --git a/docs/manpages/gbp-config.sgml b/docs/manpages/gbp-config.sgml
index 599d1168..9b3d7edd 100644
--- a/docs/manpages/gbp-config.sgml
+++ b/docs/manpages/gbp-config.sgml
@@ -21,9 +21,7 @@
     <cmdsynopsis>
       &gbp-config;
 
-      <arg><option>--verbose</option></arg>
-      <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
-      <arg><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></arg>
+      &man.common.options.synopsis;
       <group choice='req'>
 	<arg choice="plain"><replaceable>command.option</replaceable></arg>
 	<arg choice="plain"><replaceable>command</replaceable></arg>
@@ -41,34 +39,7 @@
   <refsect1>
     <title>OPTIONS</title>
     <variablelist>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-	<term><option>-v</option></term>
-        <listitem>
-          <para>verbose execution</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>--color=</option><replaceable>[auto|on|off]</replaceable>
-        </term>
-        <listitem>
-          <para>Whether to use colored output.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></term>
-        <listitem>
-          <para>
-          Colors to use in output (when color is enabled). The format for
-          COLOR_SCHEME is
-          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
-          Numerical values and color names are accepted, empty fields imply
-          the default color. For example --git-color-scheme='cyan:34::' would
-          show debug messages in cyan, info messages in blue and other messages
-          in default (i.e. warning and error messages in red).
-          </para>
-        </listitem>
-      </varlistentry>
+      &man.common.options.description;
     </variablelist>
   </refsect1>
   <refsect1>
diff --git a/docs/manpages/gbp-create-remote-repo.sgml b/docs/manpages/gbp-create-remote-repo.sgml
index a874b004..e8f6a092 100644
--- a/docs/manpages/gbp-create-remote-repo.sgml
+++ b/docs/manpages/gbp-create-remote-repo.sgml
@@ -20,8 +20,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       &gbp-create-remote-repo;
-      <arg><option>--verbose</option></arg>
-      <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
+      &man.common.options.synopsis;
       <arg><option>--remote-url-pattern=</option><replaceable>url-pattern</replaceable></arg>
       <arg><option>--remote-name=</option><replaceable>name</replaceable></arg>
       <arg><option>--template-dir=</option><replaceable>directory</replaceable></arg>
@@ -52,6 +51,8 @@
   <refsect1>
     <title>OPTIONS</title>
     <variablelist>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--remote-url-pattern</option>=<replaceable>pattern</replaceable>
         </term>
@@ -111,20 +112,6 @@
           <para>Whether to push the pristine tar branch.</para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-	<term><option>-v</option></term>
-        <listitem>
-          <para>verbose execution</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>--color=</option><replaceable>[auto|on|off]</replaceable>
-        </term>
-        <listitem>
-          <para>Whether to use colored output.</para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><option>--[no-]track</option>
         </term>
diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml
index 5d539949..8ffdc4f6 100644
--- a/docs/manpages/gbp-dch.sgml
+++ b/docs/manpages/gbp-dch.sgml
@@ -20,7 +20,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       &gbp-dch;
-      <arg><option>--verbose</option></arg>
+      &man.common.options.synopsis;
       <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
       <arg><option>--debian-tag=</option><replaceable>tag-format</replaceable></arg>
       <arg><option>--upstream-tag=</option><replaceable>tag-format</replaceable></arg>
@@ -90,6 +90,8 @@
   <refsect1>
     <title>OPTIONS</title>
     <variablelist>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
         </term>
@@ -110,15 +112,6 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-        <term><option>-v</option></term>
-        <listitem>
-          <para>
-          verbose execution
-          </para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><option>--debian-tag=</option><replaceable>tag-format</replaceable>
         </term>
diff --git a/docs/manpages/gbp-import-dsc.sgml b/docs/manpages/gbp-import-dsc.sgml
index 5549defd..e635a3d9 100644
--- a/docs/manpages/gbp-import-dsc.sgml
+++ b/docs/manpages/gbp-import-dsc.sgml
@@ -20,6 +20,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       &gbp-import-dsc;
+      &man.common.options.synopsis;
       <arg><option>--allow-same-versions</option></arg>
       <arg><option>--author-date-is-committer-date</option></arg>
       <arg><option>--author-is-committer</option></arg>
@@ -34,7 +35,6 @@
       <arg><option>--skip-debian-tag=</option></arg>
       <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
       <arg><option>--upstream-tag=</option><replaceable>tag-format</replaceable></arg>
-      <arg><option>--verbose</option></arg>
       <arg choice="plain"><replaceable>debian-source.dsc</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
@@ -60,6 +60,8 @@
   <refsect1>
     <title>OPTIONS</title>
     <variablelist>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
         </term>
@@ -80,15 +82,6 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-        <term><option>-v</option></term>
-        <listitem>
-          <para>
-          verbose execution
-          </para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><option>--[no-]sign-tags</option>
         </term>
diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml
index 967afc8c..b744752a 100644
--- a/docs/manpages/gbp-import-orig.sgml
+++ b/docs/manpages/gbp-import-orig.sgml
@@ -21,7 +21,7 @@
     <cmdsynopsis>
       &gbp-import-orig;
 
-      <arg><option>--verbose</option></arg>
+      &man.common.options.synopsis;
       <arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
       <arg><option>--[no-]merge</option></arg>
       <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
@@ -64,6 +64,8 @@
   <refsect1>
     <title>OPTIONS</title>
     <variablelist>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--upstream-version</option>=<replaceable>version</replaceable></term>
         <term><option>-u</option><replaceable>version</replaceable></term>
@@ -114,15 +116,6 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-        <term><option>-v</option></term>
-        <listitem>
-          <para>
-          verbose execution
-          </para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><option>--[no-]sign-tags</option>
         </term>
diff --git a/docs/manpages/gbp-pq.sgml b/docs/manpages/gbp-pq.sgml
index 07781893..e0942083 100644
--- a/docs/manpages/gbp-pq.sgml
+++ b/docs/manpages/gbp-pq.sgml
@@ -19,9 +19,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       &gbp-pq;
-      <arg><option>--verbose</option></arg>
-      <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
-      <arg><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></arg>
+      &man.common.options.synopsis;
       <arg><option>--[no-]patch-numbers</option></arg>
       <arg><option>--topic=</option><replaceable>topic</replaceable></arg>
       <arg><option>--time-machine=</option><replaceable>num</replaceable></arg>
@@ -125,38 +123,8 @@
   <refsect1>
     <title>OPTIONS</title>
     <variablelist>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-        <term><option>-v</option></term>
-        <listitem>
-          <para>
-          verbose execution
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>--color=</option><replaceable>[auto|on|off]</replaceable>
-        </term>
-        <listitem>
-          <para>
-          Whether to use colored output.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></term>
-        <listitem>
-          <para>
-          Colors to use in output (when color is enabled). The format for
-          COLOR_SCHEME is
-          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
-          Numerical values and color names are accepted, empty fields imply
-          the default color. For example --git-color-scheme='cyan:34::' would
-          show debug messages in cyan, info messages in blue and other messages
-          in default (i.e. warning and error messages in red).
-          </para>
-        </listitem>
-      </varlistentry>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--[no-]patch-numbers</option>
         </term>
diff --git a/docs/manpages/gbp-pull.sgml b/docs/manpages/gbp-pull.sgml
index 7a9d235f..fd658c8d 100644
--- a/docs/manpages/gbp-pull.sgml
+++ b/docs/manpages/gbp-pull.sgml
@@ -21,7 +21,7 @@
     <cmdsynopsis>
       &gbp-pull;
 
-      <arg><option>--verbose</option></arg>
+      &man.common.options.synopsis;
       <arg><option>--force</option></arg>
       <arg><option>--redo-pq</option></arg>
       <arg><option>--[no-]pristine-tar</option></arg>
@@ -44,6 +44,8 @@
     <title>OPTIONS</title>
 
     <variablelist>
+      &man.common.options.description;
+
       <varlistentry>
         <term><option>--force</option></term>
         <listitem>
@@ -89,13 +91,6 @@
           <para>Git history depth, for deepening shallow git clones.</para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term><option>--verbose</option></term>
-	<term><option>-v</option></term>
-        <listitem>
-          <para>verbose execution</para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><option>--pristine-tar</option>
         </term>
diff --git a/docs/manpages/man.common-options.ent b/docs/manpages/man.common-options.ent
new file mode 100644
index 00000000..74bd9f0d
--- /dev/null
+++ b/docs/manpages/man.common-options.ent
@@ -0,0 +1,65 @@
+<!ENTITY man.common.options.synopsis
+"
+      <arg><option>--version</option></arg>
+      <arg><option>--help</option></arg>
+      <arg><option>--verbose</option></arg>
+      <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
+      <arg><option>--color-scheme=</option><replaceable>COLOR_SCHEME</replaceable></arg>
+"
+>
+<!ENTITY man.common.options.description
+"
+      <varlistentry>
+        <term><option>--version</option></term>
+        <listitem>
+          <para>
+          Print version of the program, i.e. version of the git-buildpackage
+          suite
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-v</option></term>
+        <term><option>--verbose</option></term>
+        <listitem>
+          <para>
+          Verbose execution
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-h</option></term>
+        <term><option>--help</option></term>
+        <listitem>
+          <para>
+          Print help and exit
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--color=</option><replaceable>[auto|on|off]</replaceable>
+        </term>
+        <listitem>
+          <para>
+          Whether to use colored output.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--color-scheme=</option><replaceable>COLOR_SCHEME</replaceable>
+        </term>
+        <listitem>
+          <para>
+          Colors to use in output (when color is enabled). The format for
+          COLOR_SCHEME is
+          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
+          Numerical values and color names are accepted, empty fields imply
+          the default color. For example --git-color-scheme='cyan:34::' would
+          show debug messages in cyan, info messages in blue and other messages
+          in default (i.e. warning and error messages in red).
+          </para>
+        </listitem>
+      </varlistentry>
+"
+>
+
diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent
index d5882548..6b8ea95f 100644
--- a/docs/manpages/manpages.ent
+++ b/docs/manpages/manpages.ent
@@ -12,3 +12,5 @@
 <!ENTITY man.gbp.conf SYSTEM "gbp.conf.sgml">
 <!ENTITY man.gbp.config-files SYSTEM "man.conffiles.sgml">
 <!ENTITY man.seealso.common SYSTEM "man.seealso.sgml">
+<!ENTITY % COMMON.OPTIONS SYSTEM "man.common-options.ent">
+%COMMON.OPTIONS;
-- 
cgit v1.2.3