Skip to content

Commit c0643fe

Browse files
committed
document new-version's --bug argument
Provide examples of using the --bug argument in the --help text and man page. Change-Id: Ie0120f857a24c17032862472f1fca150f43f3f91
1 parent 9dc102a commit c0643fe

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

doc/rdopkg.1.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,18 @@ much like `rpmdev-bumpspec`:
153153

154154
rdopkg -bn
155155

156+
To note particular bugs in the changelog, use the `-B`/`--bug` option. rdopkg
157+
will append the supplied string to changelog in brackets. For example:
158+
159+
rdopkg new-version --bug rhbz#1234,rhbz#5678
160+
161+
will result in following %changelog line:
162+
163+
Update to 1.1.1 (rhbz#1234,rhbz#5678)
164+
165+
and corresponding `Resolves:` lines in commit message.
166+
167+
156168
*Flow:*
157169

158170
* Show diff from previous version, especially changes to `requirements.txt`.

rdopkg/actions/distgit/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
Arg('no_push_patches', shortcut='-t', action='store_true',
112112
help="don't push patches branch"),
113113
Arg('bug', shortcut='-B', metavar='BUG(S)',
114-
help="reference BUG(S) in changelog"),
114+
help="reference BUG(S) in changelog. (example:"
115+
" --bug rhbz#1234,rhbz#5678)"),
115116
],
116117
steps=[
117118
Action('get_package_env'),

0 commit comments

Comments
 (0)