summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2010-05-04 11:31:54 +0200
committerGuido Günther <agx@sigxcpu.org>2010-05-04 11:31:54 +0200
commitf31c82d517e76e130f32c068e493a334113566c8 (patch)
treea4175ae3cdf90b58dd28c33c7b389b8982c54e11 /docs
parent18bd09e66f6f0b6d9d896eb8ffa48a186e4b3165 (diff)
downloadgit-buildpackage-f31c82d517e76e130f32c068e493a334113566c8.tar.gz
git-buildpackage-f31c82d517e76e130f32c068e493a334113566c8.tar.bz2
git-buildpackage-f31c82d517e76e130f32c068e493a334113566c8.zip
Document Git-Dch: Ignore and Git-Dch: Short
Diffstat (limited to 'docs')
-rw-r--r--docs/chapters/releases.sgml21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml
index 00fb76f8..b3b46db3 100644
--- a/docs/chapters/releases.sgml
+++ b/docs/chapters/releases.sgml
@@ -97,7 +97,28 @@ Thanks: cool upstream
* New upstream version (Closes: #1000) - thanks to cool upstream
</screen>
You can use the <option>Closes:</option> tag multiple times.
+</para>
+<para>
+There are several tags to further customize what (and how) commit messages get
+included into the changelog:
</para><para>
+To exclude a commit from the generated changelog use:
+</para><para>
+<screen>
+Git-Dch: Ignore
+</screen>
+This is e.g. useful if you're just fixing up a previous commit and couldn't
+ammend it.
+</para>
+
+<para>
+To only include the short description in the commit and skip the body use:
+<screen>
+Git-Dch: Short
+</screen>
+This only takes effect when running &git-dch; with the <option>--full</option> option.
+</para>
+<para>
Usually changelog entries should correspond to a single &git; commit. In this case it's
convenient to include the commit id in the changelog entry.
This has the advantage that it's easy for people to identify changes without