aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2009-02-26 09:12:18 +0100
committerGuido Günther <agx@sigxcpu.org>2009-02-26 13:48:28 +0100
commit660acbe28b4f52f68ae467eb5812897236e8d6e6 (patch)
tree1ed59596304dff46b7c7526053adea79d6dce0cc
parent6ccd4828f9296c6dcd95f50881d9c719e75716e3 (diff)
better document Closes: tag
Closes: #516877
-rw-r--r--docs/chapters/releases.sgml7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml
index 8b97e10..95c2335 100644
--- a/docs/chapters/releases.sgml
+++ b/docs/chapters/releases.sgml
@@ -83,8 +83,9 @@ snapshot-number = os.popen("git-log --pretty=oneline | wc -l").readlines()[0]
<para>You can use <option>--full</option> to include the full commit
message in the changelog, note that you will lose the formatting though,
since &dch; wraps lines by itself.</para>
- <para>Additionally there are tags available to customize the commit
-message, for example the git commit message
+ <para>Additionally there are tags <option>Closes:</option> and
+<option>Thanks:</option> available to customize the commit message. Each tag
+has to start at the beginning of a single line. For example the git commit message
<screen>
New upstream version
@@ -95,7 +96,7 @@ Thanks: cool upstream
<screen>
* New upstream version (Closes: #1000) - thanks to cool upstream
</screen>
-You can use multiple <option>Closes:</option> tags.
+You can use the <option>Closes:</option> tag multiple times.
</para><para>
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.