diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chapters/releases.sgml | 12 | ||||
| -rw-r--r-- | docs/manpages/git-dch.sgml | 11 |
2 files changed, 18 insertions, 5 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml index 9d3bf747..d5cf0871 100644 --- a/docs/chapters/releases.sgml +++ b/docs/chapters/releases.sgml @@ -119,11 +119,19 @@ Git-Dch: Ignore 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: +To include the full commit message in the changelog use: +<screen> +Git-Dch: Full +</screen> +</para> +<para> +To only include the short description in the changelog and skip the body use: <screen> Git-Dch: Short </screen> -This only takes effect when running &git-dch; with the <option>--full</option> option. +The latter only takes effect when running &git-dch; with the +<option>--full</option> option, since including only the short +description is the default. </para> <para> Usually changelog entries should correspond to a single &git; commit. In this case it's diff --git a/docs/manpages/git-dch.sgml b/docs/manpages/git-dch.sgml index 3059f8d2..6dfe7bb9 100644 --- a/docs/manpages/git-dch.sgml +++ b/docs/manpages/git-dch.sgml @@ -259,9 +259,14 @@ </term> <listitem><para> Supported actions are: <replaceable>Ignore</replaceable> which will ignore - this commit when generating <filename>debian/changelog</filename> and - <replaceable>Short</replaceable> which will only use the description - (the first line) of the commit message when generating the changelog entry. + this commit when generating <filename>debian/changelog</filename>, + <replaceable>Short</replaceable> which will only use the + description (the first line) of the commit message when + generating the changelog entry (useful when + <option>--full</option> is given) and + <replaceable>Full</replaceable> which will use the full commit + message when generating the changelog entry (useful when + <option>--full</option> is not given). </para></listitem> </varlistentry> <varlistentry> |