From f31c82d517e76e130f32c068e493a334113566c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Tue, 4 May 2010 11:31:54 +0200 Subject: Document Git-Dch: Ignore and Git-Dch: Short --- docs/chapters/releases.sgml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'docs/chapters/releases.sgml') 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 You can use the tag multiple times. + + +There are several tags to further customize what (and how) commit messages get +included into the changelog: +To exclude a commit from the generated changelog use: + + +Git-Dch: Ignore + +This is e.g. useful if you're just fixing up a previous commit and couldn't +ammend it. + + + +To only include the short description in the commit and skip the body use: + +Git-Dch: Short + +This only takes effect when running &git-dch; with the option. + + 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 -- cgit v1.2.3