dch: Support Gbp-Dch: besides Git-Dch:
authorGuido Günther <agx@sigxcpu.org>
Thu, 22 Jan 2015 20:37:43 +0000 (21:37 +0100)
committerGuido Günther <agx@sigxcpu.org>
Thu, 22 Jan 2015 21:40:09 +0000 (22:40 +0100)
docs/chapters/releases.sgml
docs/manpages/gbp-dch.sgml
gbp/dch.py

index abc08fd9e6e892e27647712e7fc049930bc65a2c..64ad20617882ae2e4cef157c5f9e7a1c07b0cb12 100644 (file)
@@ -106,7 +106,7 @@ included into the changelog:
 To exclude a commit from the generated changelog use:
 </para><para>
 <screen>
-Git-Dch: Ignore
+Gbp-Dch: Ignore
 </screen>
 This is e.g. useful if you're just fixing up a previous commit and couldn't
 ammend it or for other janitorial commits that really don't need to end up in
@@ -114,20 +114,20 @@ the changelog. For example, the following git commit message
 <screen>
 Set correct branchnames in debian/gbp.conf
 
-Git-Dch: Ignore
+Gbp-Dch: Ignore
 </screen>
 will not show up in the generated changelog in any way.
 </para>
 <para>
 To include the full commit message in the changelog use:
 <screen>
-Git-Dch: Full
+Gbp-Dch: Full
 </screen>
 </para>
 <para>
 To only include the short description in the changelog and skip the body use:
 <screen>
-Git-Dch: Short
+Gbp-Dch: Short
 </screen>
 The latter only takes effect when running &gbp-dch; with the
 <option>--full</option> option, since including only the short
index 22ab5688fcce92dee8ad67fa2114dbc4083ebc00..5303c628474f90d2b551333d8cbffe79168a7a15 100644 (file)
@@ -13,8 +13,8 @@
     &dhsection;
   </refmeta>
   <refnamediv>
-    <refname>git-dch;</refname>
-    <refname>gbp-dch;</refname>
+    <refname>git-dch</refname>
+    <refname>gbp-dch</refname>
     <refpurpose>Generate the &debian; changelog from git commit messages</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
         <listitem>
           <para>
           Parse meta tags like <option>Closes:</option>,
-          <option>Thanks:</option> and <option>Git-Dch:</option>. See META TAGS
+          <option>Thanks:</option> and <option>Gbp-Dch:</option>. See META TAGS
           below.
           </para>
         </listitem>
     </para>
     <variablelist>
       <varlistentry>
-        <term><option>Git-Dch</option>: <replaceable>action</replaceable>
-        </term>
+        <term>
+         <option>Gbp-Dch</option>: <replaceable>action</replaceable>
+       </term>
         <listitem>
           <para>
-          Supported actions are: <replaceable>Ignore</replaceable> which will
-          ignore this commit when generating
-          <filename>debian/changelog</filename>,
-          <replaceable>Short</replaceable> which will only use the description
-          (the first line) of the commit message when generating the changelog
-          entry (useful when <option>--full</option> is given) and
-          <replaceable>Full</replaceable> which will use the full commit
-          message when generating the changelog entry (useful when
-          <option>--full</option> is not given).
+            Supported actions are: <replaceable>Ignore</replaceable>
+            which will ignore this commit when
+            generating <filename>debian/changelog</filename>,
+            <replaceable>Short</replaceable> which will only use the
+            description (the first line) of the commit message when
+            generating the changelog entry (useful
+            when <option>--full</option> is given) and
+            <replaceable>Full</replaceable> which will use the full
+            commit message when generating the changelog entry (useful
+            when <option>--full</option> is not given).
+         </para>
+         <para>
+           Insteaad of <option>Gbp-Dch</option> the
+           deprecated <option>Git-Dch</option> is still supported.
           </para>
         </listitem>
       </varlistentry>
 
       so one doesn't have to consult the manual
 
-      Git-Dch: Short
+      Gbp-Dch: Short
       Closes: #636088
       Thanks: Raphaël Hertzog for the suggestion
     </screen>
index f983234fa9c6c386910436154c96a336363df585..d6385ef34b2ec1f84abc3b15f069454436bccb53 100644 (file)
@@ -28,7 +28,7 @@ def extract_git_dch_cmds(lines, options):
     commands = {}
     other_lines = []
     for line in lines:
-        if line.startswith('Git-Dch: '):
+        if line.startswith('Git-Dch: ') or line.startswith('Gbp-Dch: '):
             cmd = line.split(' ', 1)[1].strip().lower()
             commands[cmd] = True
         else: