1
# Copyright (C) 2007-2010 Canonical Ltd
1
# Copyright (C) 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from bzrlib import registry
17
from bzrlib import registry, help_topics
18
18
from bzrlib.lazy_import import lazy_import
19
19
lazy_import(globals(), """
20
20
from bzrlib import errors, urlutils
41
41
"""When making a commit, metadata about bugs fixed by that change can be
42
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
42
recorded by using the --fixes option. For each bug marked as fixed, an
43
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
44
44
(The only ``status`` value currently supported is ``fixed.``)
46
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
47
rather than a full URL. This looks like::
46
The --fixes option allows you to specify a bug tracker and a bug identifier
47
rather than a full URL. This looks like
49
49
bzr commit --fixes <tracker>:<id>
53
bzr commit --fixes <id>
55
51
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
56
52
identifier for that bug within the bugtracker, usually the bug number.
57
If "<tracker>" is not specified the ``bugtracker`` set in the branch
58
or global configuration is used.
60
54
Bazaar knows about a few bug trackers that have many users. If
61
55
you use one of these bug trackers then there is no setup required to
62
56
use this feature, you just need to know the tracker identifier to use.
63
57
These are the bugtrackers that are built in:
65
============================ ============ ============
66
URL Abbreviation Example
67
============================ ============ ============
68
https://bugs.launchpad.net/ lp lp:12345
69
http://bugs.debian.org/ deb deb:12345
70
http://bugzilla.gnome.org/ gnome gnome:12345
71
============================ ============ ============
59
URL | Abbreviation | Example
60
https://bugs.launchpad.net/ | lp | lp:12345
61
http://bugs.debian.org/ | deb | deb:12345
62
http://bugzilla.gnome.org/ | gnome | gnome:12345
73
64
For the bug trackers not listed above configuration is required.
74
65
Support for generating the URLs for any project using Bugzilla or Trac
92
83
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
94
bugzilla_<tracker>_url
95
----------------------
85
bugzilla_<tracker_abbreviation>_url
86
-----------------------------------
97
88
If present, the location of the Bugzilla bug tracker referred to by
98
<tracker>. This option can then be used together with ``bzr commit
89
<tracker_abbreviation>. This option can then be used together with ``bzr commit
99
90
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
102
bugzilla_squid_url = http://bugs.squid-cache.org
93
bugzilla_squid_url = http://www.squid-cache.org/bugs
104
95
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
98
trac_<tracker_abbrevation>_url
99
------------------------------
110
101
If present, the location of the Trac instance referred to by
111
<tracker>. This option can then be used together with ``bzr commit
102
<tracker_abbreviation>. This option can then be used together with ``bzr commit
112
103
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
117
108
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
120
bugtracker_<tracker>_url
121
------------------------
111
bugtracker_<tracker_abbrevation>_url
112
------------------------------------
123
114
If present, the location of a generic bug tracker instance referred to by
124
<tracker>. The location must contain an ``{id}`` placeholder,
115
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
125
116
which will be replaced by a specific bug ID. This option can then be used
126
117
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
127
118
fixed by that commit. For example::
134
125
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
136
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
137
RT bug tracker as fixed, or::
139
bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
141
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
142
in Hudson's JIRA bug tracker as fixed.
127
for CPAN's RT bug tracker.
239
224
tracker_registry.register('gnome',
240
UniqueIntegerBugTracker('gnome',
241
'http://bugzilla.gnome.org/show_bug.cgi?id='))
244
class URLParametrizedBugTracker(BugTracker):
225
UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
228
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
245
229
"""A type of bug tracker that can be found on a variety of different sites,
246
230
and thus needs to have the base URL configured.
248
232
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
249
`type_name` is the name of the type of tracker and `abbreviation`
250
is a short name for the particular instance.
233
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
234
and `abbreviation` is a short name for the particular instance (e.g.
235
'squid' or 'apache').
253
238
def get(self, abbreviation, branch):
254
239
config = branch.get_config()
255
240
url = config.get_user_option(
256
"%s_%s_url" % (self.type_name, abbreviation), expand=False)
241
"%s_%s_url" % (self.type_name, abbreviation))
259
244
self._base_url = url
268
253
return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
271
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
272
URLParametrizedBugTracker):
273
"""A type of bug tracker that only allows integer bug IDs.
275
This can be found on a variety of different sites, and thus needs to have
276
the base URL configured.
278
Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
279
`type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
280
and `abbreviation` is a short name for the particular instance (e.g.
281
'squid' or 'apache').
284
256
tracker_registry.register(
285
257
'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
289
261
URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
292
class GenericBugTracker(URLParametrizedBugTracker):
264
class GenericBugTracker(URLParametrizedIntegerBugTracker):
293
265
"""Generic bug tracker specified by an URL template."""
295
267
def __init__(self):