← 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: 2008-01-04 01:48:32 UTC
  • mto: This revision was merged to the branch mainline in revision 3165.
  • Revision ID: john@arbash-meinel.com-20080104014832-1xwbcbueft0cyqtc
a small bit of cleanup.

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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from bzrlib import registry
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
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
 
(The only ``status`` value currently supported is ``fixed.``)
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::
48
 
 
49
 
    bzr commit --fixes <tracker>:<id>
50
 
 
51
 
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
52
 
identifier for that bug within the bugtracker, usually the bug number.
53
 
 
54
 
Bazaar knows about a few bug trackers that have many users. If
55
 
you use one of these bug trackers then there is no setup required to
56
 
use this feature, you just need to know the tracker identifier to use.
57
 
These are the bugtrackers that are built in:
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
 
  ============================ ============ ============
66
 
 
67
 
For the bug trackers not listed above configuration is required.
68
 
Support for generating the URLs for any project using Bugzilla or Trac
69
 
is built in, along with a template mechanism for other bugtrackers with
70
 
simple URL schemes. If your bug tracker can't be described by one
71
 
of the schemes described below then you can write a plugin to support
72
 
it.
73
 
 
 
46
Support for Launchpad's central bug tracker is built in. For other bug
 
47
trackers, configuration is required in advance so that the correct URL
 
48
can be recorded.
 
49
 
 
50
In addition to Launchpad, Bazaar directly supports the generation of
 
51
URLs appropriate for Bugzilla and Trac. If your project uses a different
 
52
bug tracker, it is easy to add support for it by writing a plugin, say.
74
53
If you use Bugzilla or Trac, then you only need to set a configuration
75
54
variable which contains the base URL of the bug tracker. These options
76
55
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
80
59
Note: As you provide a short name for each tracker, you can specify one or
81
60
more bugs in one or more trackers at commit time if you wish.
82
61
 
83
 
Launchpad
84
 
---------
85
 
 
86
 
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
87
 
 
88
 
bugzilla_<tracker>_url
89
 
----------------------
 
62
bugzilla_<tracker_abbreviation>_url
 
63
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
64
 
91
65
If present, the location of the Bugzilla bug tracker referred to by
92
 
<tracker>. This option can then be used together with ``bzr commit
 
66
<tracker_abbreviation>. This option can then be used together with ``bzr commit
93
67
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
94
68
example::
95
69
 
98
72
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
99
73
fixed.
100
74
 
101
 
trac_<tracker>_url
102
 
------------------
 
75
trac_<tracker_abbrevation>_url
 
76
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103
77
 
104
78
If present, the location of the Trac instance referred to by
105
 
<tracker>. This option can then be used together with ``bzr commit
 
79
<tracker_abbreviation>. This option can then be used together with ``bzr commit
106
80
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
107
81
example::
108
82
 
111
85
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
112
86
fixed.
113
87
 
114
 
bugtracker_<tracker>_url
115
 
------------------------
116
 
 
 
88
bugtracker_<tracker_abbrevation>_url
 
89
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117
90
If present, the location of a generic bug tracker instance referred to by
118
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
91
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
119
92
which will be replaced by a specific bug ID. This option can then be used
120
93
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
121
94
fixed by that commit. For example::
196
169
    """A style of bug tracker that exists in one place only, such as Launchpad.
197
170
 
198
171
    If you have one of these trackers then register an instance passing in an
199
 
    abbreviated name for the bug tracker and a base URL. The bug ids are
200
 
    appended directly to the URL.
 
172
    abbreviated name for the bug tracker and a base URL.
201
173
    """
202
174
 
203
175
    def __init__(self, abbreviated_bugtracker_name, base_url):
213
185
 
214
186
    def _get_bug_url(self, bug_id):
215
187
        """Return the URL for bug_id."""
216
 
        return self.base_url + bug_id
 
188
        return urlutils.join(self.base_url, bug_id)
217
189
 
218
190
 
219
191
tracker_registry.register(
224
196
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
225
197
 
226
198
 
227
 
tracker_registry.register('gnome',
228
 
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
229
 
 
230
 
 
231
199
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
232
200
    """A type of bug tracker that can be found on a variety of different sites,
233
201
    and thus needs to have the base URL configured.
283
251
 
284
252
 
285
253
tracker_registry.register('generic', GenericBugTracker())
286
 
 
287
 
 
288
 
FIXED = 'fixed'
289
 
 
290
 
ALLOWED_BUG_STATUSES = set([FIXED])
291
 
 
292
 
 
293
 
def encode_fixes_bug_urls(bug_urls):
294
 
    """Get the revision property value for a commit that fixes bugs.
295
 
 
296
 
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
297
 
        come from `get_bug_url`.
298
 
    :return: A string that will be set as the 'bugs' property of a revision
299
 
        as part of a commit.
300
 
    """
301
 
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)