summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Lehtonen <markus.lehtonen@linux.intel.com>2014-06-06 12:40:32 +0300
committerMarkus Lehtonen <markus.lehtonen@linux.intel.com>2014-11-14 14:47:20 +0200
commitf551fab4b20e1d8cd9a069928f54756f2f963d83 (patch)
tree0fe57f417c656e0b1aaff2735e60f03003537f52 /docs
parent72fdb2c35c188ad2d14da68befc54241f592467e (diff)
downloadgit-buildpackage-f551fab4b20e1d8cd9a069928f54756f2f963d83.tar.gz
git-buildpackage-f551fab4b20e1d8cd9a069928f54756f2f963d83.tar.bz2
git-buildpackage-f551fab4b20e1d8cd9a069928f54756f2f963d83.zip
rpm-ch: implement --meta-bts option
This gives the user the possibility to define what meta tags (in git commit message) git-rpm-ch recognizes as bug tracking system references. Or, makes it possible to disable bts meta tag tracking altogether. Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/manpages/gbp-rpm-ch.sgml21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/manpages/gbp-rpm-ch.sgml b/docs/manpages/gbp-rpm-ch.sgml
index 59adaa5a..fbd28967 100644
--- a/docs/manpages/gbp-rpm-ch.sgml
+++ b/docs/manpages/gbp-rpm-ch.sgml
@@ -33,6 +33,7 @@
<arg><option>--message=</option><replaceable>MESSAGE</replaceable></arg>
<arg><option>--since=</option><replaceable>COMMITISH</replaceable></arg>
</group>
+ <arg><option>--meta-bts=</option><replaceable>META_TAGS</replaceable></arg>
<arg><option>--no-release</option></arg>
<arg><option>--[no-]git-author</option></arg>
<arg><option>--[no-]full</option></arg>
@@ -171,6 +172,19 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--meta-bts=</option><replaceable>META_TAGS</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Meta tags in the commit messages that are interpreted as bug tracking
+ system related references. The recognized bts references are added in
+ the generated changelog entries. See the META TAGS section below for
+ more information. The bts meta tag tracking feature can be disabled
+ by defining an empty string.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--no-release</option>
</term>
<listitem>
@@ -378,11 +392,14 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>[Close|Closes|Fix|Fixes]</option>: <replaceable>BUGNUMBER</replaceable>
+ <term><option>[Close|Closes|...]</option>: <replaceable>BUGNUMBER</replaceable>
</term>
<listitem>
<para>
- Indicate in the changelog that the bug was addressed by this commit.
+ Indicate in the changelog entry that bug
+ <replaceable>BUGNUMBER</replaceable> was addressed in this commit.
+ The bts meta tags recognized by &gbp-rpm-ch; is actually defined by
+ the <option>--meta-bts</option> option.
</para>
</listitem>
</varlistentry>