← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-04 16:50:33 UTC
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: john@arbash-meinel.com-20090604165033-bfdo0lyf4yt4vjcz
We don't need a base Coder class, because Decoder._update_tail is different than Encoder._update_tail.
(one adds, one subtracts from self.size).
So we now have 2 versions of the macro, and the test suite stops crashing... :)

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
 
51
 
or::
52
 
 
53
 
    bzr commit --fixes <id>
54
 
 
55
53
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
56
54
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.
59
55
 
60
56
Bazaar knows about a few bug trackers that have many users. If
61
57
you use one of these bug trackers then there is no setup required to
62
58
use this feature, you just need to know the tracker identifier to use.
63
59
These are the bugtrackers that are built in:
64
60
 
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
 
  ============================ ============ ============
 
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
72
65
 
73
66
For the bug trackers not listed above configuration is required.
74
67
Support for generating the URLs for any project using Bugzilla or Trac
91
84
 
92
85
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
93
86
 
94
 
bugzilla_<tracker>_url
95
 
----------------------
 
87
bugzilla_<tracker_abbreviation>_url
 
88
-----------------------------------
96
89
 
97
90
If present, the location of the Bugzilla bug tracker referred to by
98
 
<tracker>. This option can then be used together with ``bzr commit
 
91
<tracker_abbreviation>. This option can then be used together with ``bzr commit
99
92
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
100
93
example::
101
94
 
102
 
    bugzilla_squid_url = http://bugs.squid-cache.org
 
95
    bugzilla_squid_url = http://www.squid-cache.org/bugs
103
96
 
104
97
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
105
98
fixed.
106
99
 
107
 
trac_<tracker>_url
108
 
------------------
 
100
trac_<tracker_abbrevation>_url
 
101
------------------------------
109
102
 
110
103
If present, the location of the Trac instance referred to by
111
 
<tracker>. This option can then be used together with ``bzr commit
 
104
<tracker_abbreviation>. This option can then be used together with ``bzr commit
112
105
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
113
106
example::
114
107
 
117
110
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
118
111
fixed.
119
112
 
120
 
bugtracker_<tracker>_url
121
 
------------------------
 
113
bugtracker_<tracker_abbrevation>_url
 
114
------------------------------------
122
115
 
123
116
If present, the location of a generic bug tracker instance referred to by
124
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
117
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
125
118
which will be replaced by a specific bug ID. This option can then be used
126
119
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
127
120
fixed by that commit. For example::
133
126
 
134
127
    bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
135
128
 
136
 
would allow ``bzr commit --fixes cpan:1234`` to mark bug 1234 in CPAN's
137
 
RT bug tracker as fixed, or::
138
 
 
139
 
    bugtracker_hudson_url = http://issues.hudson-ci.org/browse/{id}
140
 
 
141
 
would allow ``bzr commit --fixes hudson:HUDSON-1234`` to mark bug HUDSON-1234
142
 
in Hudson's JIRA bug tracker as fixed.
 
129
for CPAN's RT bug tracker.
143
130
"""
144
131
 
145
132
 
237
224
 
238
225
 
239
226
tracker_registry.register('gnome',
240
 
    UniqueIntegerBugTracker('gnome',
241
 
                            'http://bugzilla.gnome.org/show_bug.cgi?id='))
242
 
 
243
 
 
244
 
class URLParametrizedBugTracker(BugTracker):
 
227
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
228
 
 
229
 
 
230
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
245
231
    """A type of bug tracker that can be found on a variety of different sites,
246
232
    and thus needs to have the base URL configured.
247
233
 
248
234
    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.
 
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').
251
238
    """
252
239
 
253
240
    def get(self, abbreviation, branch):
254
241
        config = branch.get_config()
255
242
        url = config.get_user_option(
256
 
            "%s_%s_url" % (self.type_name, abbreviation), expand=False)
 
243
            "%s_%s_url" % (self.type_name, abbreviation))
257
244
        if url is None:
258
245
            return None
259
246
        self._base_url = url
268
255
        return urlutils.join(self._base_url, self._bug_area) + str(bug_id)
269
256
 
270
257
 
271
 
class URLParametrizedIntegerBugTracker(IntegerBugTracker,
272
 
                                       URLParametrizedBugTracker):
273
 
    """A type of bug tracker that  only allows integer bug IDs.
274
 
 
275
 
    This can be found on a variety of different sites, and thus needs to have
276
 
    the base URL configured.
277
 
 
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').
282
 
    """
283
 
 
284
258
tracker_registry.register(
285
259
    'trac', URLParametrizedIntegerBugTracker('trac', 'ticket/'))
286
260
 
289
263
    URLParametrizedIntegerBugTracker('bugzilla', 'show_bug.cgi?id='))
290
264
 
291
265
 
292
 
class GenericBugTracker(URLParametrizedBugTracker):
 
266
class GenericBugTracker(URLParametrizedIntegerBugTracker):
293
267
    """Generic bug tracker specified by an URL template."""
294
268
 
295
269
    def __init__(self):