aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGuido Guenther <agx@sigxcpu.org>2008-03-14 20:42:21 +0100
committerGuido Guenther <agx@sigxcpu.org>2008-03-14 20:42:21 +0100
commit2d6b2378fa2382d987d5776a00b5addb653f95ab (patch)
treee738e5d55b529cbc9540e4e678703441bfeec8df /docs
parentb6b40eb03bffe0511823b5f69539c0b69a88edfd (diff)
document --full and --meta
Diffstat (limited to 'docs')
-rw-r--r--docs/chapters/releases.sgml20
-rw-r--r--docs/manpages/git-dch.sgml16
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml
index 1509ae1..4e1874b 100644
--- a/docs/chapters/releases.sgml
+++ b/docs/chapters/releases.sgml
@@ -78,4 +78,24 @@ You can also add the snapshot-number calculation to <filename>gbp.conf</filename
snapshot-number = os.popen("git-log --pretty=oneline | wc -l").readlines()[0]
</programlisting>
</sect1>
+<sect1 id="gbp.release.commit">
+ <title>More on commit messages</title>
+ <para>You can use <option>--full</option> to include the full commit
+ message in the changelog, note that you will lose the formatting though,
+ since &dch; wraps lines by itself.</para>
+ <para>Additionally you can use tags to customize the commit message, for
+ example the git commit message
+<screen>
+New upstream version
+
+Closes: #1000
+Thanks: cool upstream
+</screen>
+ would result in a changelog entry
+<screen>
+ * New upstream version (Closes: #1000) - thanks to cool upstream
+</screen>
+You can use multiple <option>Closes:</option> tags.
+</para>
+</sect1>
</chapter>
diff --git a/docs/manpages/git-dch.sgml b/docs/manpages/git-dch.sgml
index 9f1eccb..b9aa16b 100644
--- a/docs/manpages/git-dch.sgml
+++ b/docs/manpages/git-dch.sgml
@@ -28,6 +28,8 @@
<arg><option>--snapshot</option></arg>
<arg><option>--release</option></arg>
<arg><option>--auto</option></arg>
+ <arg><option>--full</option></arg>
+ <arg><option>--meta</option></arg>
<arg><option>--snapshot-number=</option><replaceable>expression</replaceable></arg>
<arg><option>--git-log=</option><replaceable>git-log-options</replaceable></arg>
<arg choice="plain"><replaceable>[path1 path2]</replaceable></arg>
@@ -98,6 +100,20 @@
snapshot banner (or from the last tag if no snapshot banner exists).
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--meta</option></term>
+ <listitem>
+ <para>Parse meta tags like <option>Closes:</option> and
+ <option>Thanks:</option>. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--full</option></term>
+ <listitem>
+ <para>Include the full commit message in the changelog output</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>--snapshot</option></term>
<listitem>