43
"""When making a commit, metadata about bugs fixed by that change can be
44
recorded by using the --fixes option. For each bug marked as fixed, an
45
entry is included in the 'bugs' revision property stating '<url> <status>'.
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
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.
53
If you use Bugzilla or Trac, then you only need to set a configuration
54
variable which contains the base URL of the bug tracker. These options
55
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
56
configuration section in ``locations.conf``. You can set up these values
57
for each of the projects you work on.
59
Note: As you provide a short name for each tracker, you can specify one or
60
more bugs in one or more trackers at commit time if you wish.
62
bugzilla_<tracker_abbreviation>_url
63
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65
If present, the location of the Bugzilla bug tracker referred to by
66
<tracker_abbreviation>. This option can then be used together with ``bzr commit
67
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
70
bugzilla_squid_url = http://www.squid-cache.org/bugs
72
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
75
trac_<tracker_abbrevation>_url
76
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78
If present, the location of the Trac instance referred to by
79
<tracker_abbreviation>. This option can then be used together with ``bzr commit
80
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
83
trac_twisted_url = http://www.twistedmatrix.com/trac
85
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
88
bugtracker_<tracker_abbrevation>_url
89
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
If present, the location of a generic bug tracker instance referred to by
91
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
92
which will be replaced by a specific bug ID. This option can then be used
93
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
94
fixed by that commit. For example::
96
bugtracker_python_url = http://bugs.python.org/issue{id}
98
would allow ``bzr commit --fixes python:1234`` to mark bug 1234 in Python's
99
Roundup bug tracker as fixed, or::
101
bugtracker_cpan_url = http://rt.cpan.org/Public/Bug/Display.html?id={id}
103
for CPAN's RT bug tracker.
42
107
def get_bug_url(abbreviated_bugtracker_name, branch, bug_id):
43
108
"""Return a URL pointing to the canonical web page of the bug identified by
67
132
def help_topic(self, topic):
68
return textwrap.dedent("""\
69
Bazaar provides the ability to store information about bugs being fixed
70
as metadata on a revision.
72
For each bug marked as fixed, an entry is included in the 'bugs'
73
revision property stating '<url> <status>'.
77
136
tracker_registry = TrackerRegistry()
added
removed
bzrlib/bugtracker.py
