aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2010-06-29 17:42:21 +0200
committerGuido Günther <agx@sigxcpu.org>2010-06-29 17:49:36 +0200
commit877166c2d4f8509628d1090ca64f165a765befd7 (patch)
treeffab31481f91734b66ede81fde40017442fbddf1
parent24410e932228f33d60b84f7fce6a2dea29f951a1 (diff)
Don't document Git-Dch: twice
Closes: #587456 Thanks: Matthijs Kooijman
-rw-r--r--docs/chapters/releases.sgml28
1 files changed, 8 insertions, 20 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml
index b3b46db3..c5d2579c 100644
--- a/docs/chapters/releases.sgml
+++ b/docs/chapters/releases.sgml
@@ -108,9 +108,15 @@ To exclude a commit from the generated changelog use:
Git-Dch: Ignore
</screen>
This is e.g. useful if you're just fixing up a previous commit and couldn't
-ammend it.
-</para>
+ammend it or for other janitorial commits that really don't need to end up in
+the changelog. 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>
<para>
To only include the short description in the commit and skip the body use:
<screen>
@@ -136,23 +142,5 @@ 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>