← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Martin Pool
  • Date: 2009-07-10 06:46:10 UTC
  • mto: (4525.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4526.
  • Revision ID: mbp@sourcefrog.net-20090710064610-sqviksbqp5i34sw2
Rename to per_interrepository

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
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
39
39
 
40
40
_bugs_help = \
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.``)
45
45
 
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
48
48
 
49
49
    bzr commit --fixes <tracker>:<id>
50
50
 
56
56
use this feature, you just need to know the tracker identifier to use.
57
57
These are the bugtrackers that are built in:
58
58
 
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
 
  ============================ ============ ============
 
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
66
63
 
67
64
For the bug trackers not listed above configuration is required.
68
65
Support for generating the URLs for any project using Bugzilla or Trac
85
82
 
86
83
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
87
84
 
88
 
bugzilla_<tracker>_url
89
 
----------------------
 
85
bugzilla_<tracker_abbreviation>_url
 
86
-----------------------------------
90
87
 
91
88
If present, the location of the Bugzilla bug tracker referred to by
92
 
<tracker>. This option can then be used together with ``bzr commit
 
89
<tracker_abbreviation>. This option can then be used together with ``bzr commit
93
90
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
94
91
example::
95
92
 
96
 
    bugzilla_squid_url = http://bugs.squid-cache.org
 
93
    bugzilla_squid_url = http://www.squid-cache.org/bugs
97
94
 
98
95
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
99
96
fixed.
100
97
 
101
 
trac_<tracker>_url
102
 
------------------
 
98
trac_<tracker_abbrevation>_url
 
99
------------------------------
103
100
 
104
101
If present, the location of the Trac instance referred to by
105
 
<tracker>. This option can then be used together with ``bzr commit
 
102
<tracker_abbreviation>. This option can then be used together with ``bzr commit
106
103
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
107
104
example::
108
105
 
111
108
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
112
109
fixed.
113
110
 
114
 
bugtracker_<tracker>_url
115
 
------------------------
 
111
bugtracker_<tracker_abbrevation>_url
 
112
------------------------------------
116
113
 
117
114
If present, the location of a generic bug tracker instance referred to by
118
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
115
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
119
116
which will be replaced by a specific bug ID. This option can then be used
120
117
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
121
118
fixed by that commit. For example::
127
124
 
128
125
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
129
126
 
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.
 
127
for CPAN's RT bug tracker.
137
128
"""
138
129
 
139
130
 
234
225
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
235
226
 
236
227
 
237
 
class URLParametrizedBugTracker(BugTracker):
 
228
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
238
229
    """A type of bug tracker that can be found on a variety of different sites,
239
230
    and thus needs to have the base URL configured.
240
231
 
241
232
    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.
 
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').
244
236
    """
245
237
 
246
238
    def get(self, abbreviation, branch):
261
253
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
262
254
 
263
255
 
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
256
tracker_registry.register(
275
257
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
276
258
 
279
261
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
280
262
 
281
263
 
282
 
class GenericBugTracker(URLParametrizedBugTracker):
 
264
class GenericBugTracker(URLParametrizedIntegerBugTracker):
283
265
    """Generic bug tracker specified by an URL template."""
284
266
 
285
267
    def __init__(self):