diff options
| author | Guido Guenther <agx@sigxcpu.org> | 2008-05-16 14:19:42 +0200 |
|---|---|---|
| committer | Guido Guenther <agx@sigxcpu.org> | 2008-05-16 14:22:43 +0200 |
| commit | ce152d4078c0fc93845865cadda816c7c9ebabe4 (patch) | |
| tree | 958e646c75fdb5ec284ee39542b303dc6b9ba45b /docs/chapters/releases.sgml | |
| parent | 6886317f1b81e9a20ae4d57b8942bec65c4233e7 (diff) | |
include the commit id in the changelog entry
Diffstat (limited to 'docs/chapters/releases.sgml')
| -rw-r--r-- | docs/chapters/releases.sgml | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml index 4e1874b4..1130d1d3 100644 --- a/docs/chapters/releases.sgml +++ b/docs/chapters/releases.sgml @@ -93,9 +93,18 @@ Thanks: cool upstream </screen> would result in a changelog entry <screen> - * New upstream version (Closes: #1000) - thanks to cool upstream + * New upstream version (Closes: #1000) - thanks to cool upstream </screen> You can use multiple <option>Closes:</option> tags. +</para><para> +Often changelog entries correspond to a single &git; commit. In this case it's +convenient to include the commit id in the chagenlog entry. This can be done +via the <option>--id-length</option> option. Using +<option>--id-length</option>=<replaceable>7</replaceable> would change the above example to: +<screen> + * [571bfd4] New upstream version (Closes: #1000) - thanks to cool upstream +</screen> +This makes it much easier to see which commit actually fixed bug #1000. </para> </sect1> </chapter> |