aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/chapters
diff options
context:
space:
mode:
authorMatthijs Kooijman <matthijs@stdin.nl>2009-12-17 12:54:23 +0100
committerGuido Günther <agx@sigxcpu.org>2009-12-17 15:44:11 +0100
commit725b9d34b81a1a415ac710458487a78d4f4f4e09 (patch)
tree65c207f50254f49a10de87723440d022deff343b /docs/chapters
parente339c701d5c8264df093a15d9db236b710da5f2b (diff)
Add support for a Git-Dch: Ignore metaheader.
Closes: #561346 Thanks: Matthijs Kooijman
Diffstat (limited to 'docs/chapters')
-rw-r--r--docs/chapters/releases.sgml18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml
index 95c2335d..00fb76f8 100644
--- a/docs/chapters/releases.sgml
+++ b/docs/chapters/releases.sgml
@@ -115,5 +115,23 @@ via &git-dch;'s <option>--id-length</option> option. Using
</screen>
This makes it much easier to see which commit actually fixed bug #1000.
</para>
+<para>
+Finally, there is the <option>Git-Dch:</option> header that can
+currently only be set to <option>Ignore</option> (or omitted). When this
+header is set to <option>Ignore</option>, the commit message is
+completely ignored and will not be included in the changelog at all.
+This is useful for janitorial commits or other commits that really don't
+need to end up in the changelog.
+
+</para><para>
+For example, the following git commit message
+<screen>
+Set correct branchnames in debian/gbp.conf
+
+Git-Dch: Ignore
+</screen>
+will not show up in the generated changelog in any way.
+</para>
+
</sect1>
</chapter>