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>

10 files changed, 90 insertions, 128 deletions

diff --git a/docs/manpages/gbp-clone.sgml b/docs/manpages/gbp-clone.sgml
index 2dec88d..20e6147 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>
@@ -75,13 +77,6 @@
         </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>
         <listitem>
diff --git a/docs/manpages/gbp-config.sgml b/docs/manpages/gbp-config.sgml
index 599d116..9b3d7ed 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 a874b00..e8f6a09 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>
@@ -112,20 +113,6 @@
         </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>
         <listitem>
diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml
index 5d53994..8ffdc4f 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>
@@ -111,15 +113,6 @@
         </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>
         <listitem>
diff --git a/docs/manpages/gbp-import-dsc.sgml b/docs/manpages/gbp-import-dsc.sgml
index 5549def..e635a3d 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>
@@ -81,15 +83,6 @@
         </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>
         <listitem>
diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml
index 967afc8..b744752 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>
@@ -115,15 +117,6 @@
         </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>
         <listitem>
diff --git a/docs/manpages/gbp-pq.sgml b/docs/manpages/gbp-pq.sgml
index 0778189..e094208 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 7a9d235..fd658c8 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>
@@ -90,13 +92,6 @@
         </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>
         <listitem>
diff --git a/docs/manpages/man.common-options.ent b/docs/manpages/man.common-options.ent
new file mode 100644
index 0000000..74bd9f0
--- /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 d588254..6b8ea95 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;