← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-06-18 20:25:52 UTC
  • mfrom: (4413.5.15 1.16-chk-direct)
  • Revision ID: pqm@pqm.ubuntu.com-20090618202552-xyl6tcvbxtm8bupf
(jam) Improve initial commit performance by creating a CHKMap in bulk,
        rather than via O(tree) map() calls.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
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
16
16
 
17
 
from bzrlib import registry
 
17
import textwrap
 
18
 
 
19
from bzrlib import registry, help_topics
18
20
from bzrlib.lazy_import import lazy_import
19
21
lazy_import(globals(), """
20
22
from bzrlib import errors, urlutils
39
41
 
40
42
_bugs_help = \
41
43
"""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
 
44
recorded by using the --fixes option. For each bug marked as fixed, an
43
45
entry is included in the 'bugs' revision property stating '<url> <status>'.
44
46
(The only ``status`` value currently supported is ``fixed.``)
45
47
 
46
 
The ``--fixes`` option allows you to specify a bug tracker and a bug identifier
47
 
rather than a full URL. This looks like::
 
48
The --fixes option allows you to specify a bug tracker and a bug identifier
 
49
rather than a full URL. This looks like
48
50
 
49
51
    bzr commit --fixes <tracker>:<id>
50
52
 
56
58
use this feature, you just need to know the tracker identifier to use.
57
59
These are the bugtrackers that are built in:
58
60
 
59
 
  ============================ ============ ============
60
 
  URL                          Abbreviation Example
61
 
  ============================ ============ ============
62
 
  https://bugs.launchpad.net/  lp           lp:12345
63
 
  http://bugs.debian.org/      deb          deb:12345
64
 
  http://bugzilla.gnome.org/   gnome        gnome:12345
65
 
  ============================ ============ ============
 
61
     URL                          | Abbreviation | Example
 
62
     https://bugs.launchpad.net/  | lp           | lp:12345
 
63
     http://bugs.debian.org/      | deb          | deb:12345
 
64
     http://bugzilla.gnome.org/   | gnome        | gnome:12345
66
65
 
67
66
For the bug trackers not listed above configuration is required.
68
67
Support for generating the URLs for any project using Bugzilla or Trac
85
84
 
86
85
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
87
86
 
88
 
bugzilla_<tracker>_url
89
 
----------------------
 
87
bugzilla_<tracker_abbreviation>_url
 
88
-----------------------------------
90
89
 
91
90
If present, the location of the Bugzilla bug tracker referred to by
92
 
<tracker>. This option can then be used together with ``bzr commit
 
91
<tracker_abbreviation>. This option can then be used together with ``bzr commit
93
92
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
94
93
example::
95
94
 
96
 
    bugzilla_squid_url = http://bugs.squid-cache.org
 
95
    bugzilla_squid_url = http://www.squid-cache.org/bugs
97
96
 
98
97
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
99
98
fixed.
100
99
 
101
 
trac_<tracker>_url
102
 
------------------
 
100
trac_<tracker_abbrevation>_url
 
101
------------------------------
103
102
 
104
103
If present, the location of the Trac instance referred to by
105
 
<tracker>. This option can then be used together with ``bzr commit
 
104
<tracker_abbreviation>. This option can then be used together with ``bzr commit
106
105
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
107
106
example::
108
107
 
111
110
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
112
111
fixed.
113
112
 
114
 
bugtracker_<tracker>_url
115
 
------------------------
 
113
bugtracker_<tracker_abbrevation>_url
 
114
------------------------------------
116
115
 
117
116
If present, the location of a generic bug tracker instance referred to by
118
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
117
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
119
118
which will be replaced by a specific bug ID. This option can then be used
120
119
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
121
120
fixed by that commit. For example::
127
126
 
128
127
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
129
128
 
130
 
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
131
 
RT bug tracker as fixed, or::
132
 
 
133
 
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
134
 
 
135
 
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
136
 
in Hudson's JIRA bug tracker as fixed.
 
129
for CPAN's RT bug tracker.
137
130
"""
138
131
 
139
132
 
234
227
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
235
228
 
236
229
 
237
 
class URLParametrizedBugTracker(BugTracker):
 
230
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
238
231
    """A type of bug tracker that can be found on a variety of different sites,
239
232
    and thus needs to have the base URL configured.
240
233
 
241
234
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
242
 
    `type_name` is the name of the type of tracker and `abbreviation`
243
 
    is a short name for the particular instance.
 
235
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
 
236
    and `abbreviation` is a short name for the particular instance (e.g.
 
237
    'squid' or 'apache').
244
238
    """
245
239
 
246
240
    def get(self, abbreviation, branch):
261
255
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
262
256
 
263
257
 
264
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker, URLParametrizedBugTracker):
265
 
    """A type of bug tracker that can be found on a variety of different sites,
266
 
    and thus needs to have the base URL configured, but only allows integer bug IDs.
267
 
 
268
 
    Looks for a config setting in the form '<type_name>_<abbreviation>_url'.
269
 
    `type_name` is the name of the type of tracker (e.g. 'bugzilla' or 'trac')
270
 
    and `abbreviation` is a short name for the particular instance (e.g.
271
 
    'squid' or 'apache').
272
 
    """
273
 
 
274
258
tracker_registry.register(
275
259
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
276
260
 
279
263
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
280
264
 
281
265
 
282
 
class GenericBugTracker(URLParametrizedBugTracker):
 
266
class GenericBugTracker(URLParametrizedIntegerBugTracker):
283
267
    """Generic bug tracker specified by an URL template."""
284
268
 
285
269
    def __init__(self):