← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Andrew Bennetts
  • Date: 2010-01-12 03:53:21 UTC
  • mfrom: (4948 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4964.
  • Revision ID: andrew.bennetts@canonical.com-20100112035321-hofpz5p10224ryj3
Merge lp:bzr, resolving conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
import textwrap
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
from bzrlib import registry, help_topics
20
18
from bzrlib.lazy_import import lazy_import
41
39
 
42
40
_bugs_help = \
43
41
"""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
 
42
recorded by using the ``--fixes`` option. For each bug marked as fixed, an
45
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
46
44
(The only ``status`` value currently supported is ``fixed.``)
47
 
Support for Launchpad's central bug tracker is built in. For other bug
48
 
trackers, configuration is required in advance so that the correct URL
49
 
can be recorded.
50
 
 
51
 
In addition to Launchpad, Bazaar directly supports the generation of
52
 
URLs appropriate for Bugzilla and Trac. If your project uses a different
53
 
bug tracker, it is easy to add support for it.
 
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
 
54
74
If you use Bugzilla or Trac, then you only need to set a configuration
55
75
variable which contains the base URL of the bug tracker. These options
56
76
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
65
85
 
66
86
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
67
87
 
68
 
bugzilla_<tracker_abbreviation>_url
69
 
-----------------------------------
 
88
bugzilla_<tracker>_url
 
89
----------------------
70
90
 
71
91
If present, the location of the Bugzilla bug tracker referred to by
72
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
92
<tracker>. This option can then be used together with ``bzr commit
73
93
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
74
94
example::
75
95
 
78
98
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
79
99
fixed.
80
100
 
81
 
trac_<tracker_abbrevation>_url
82
 
------------------------------
 
101
trac_<tracker>_url
 
102
------------------
83
103
 
84
104
If present, the location of the Trac instance referred to by
85
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
105
<tracker>. This option can then be used together with ``bzr commit
86
106
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
87
107
example::
88
108
 
91
111
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
92
112
fixed.
93
113
 
94
 
bugtracker_<tracker_abbrevation>_url
95
 
------------------------------------
 
114
bugtracker_<tracker>_url
 
115
------------------------
96
116
 
97
117
If present, the location of a generic bug tracker instance referred to by
98
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
118
<tracker>. The location must contain an ``{id}`` placeholder,
99
119
which will be replaced by a specific bug ID. This option can then be used
100
120
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
101
121
fixed by that commit. For example::
263
283
 
264
284
 
265
285
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)