← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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
 
import textwrap
18
 
 
19
 
from bzrlib import registry, help_topics
 
17
from bzrlib import registry
20
18
from bzrlib.lazy_import import lazy_import
21
19
lazy_import(globals(), """
22
20
from bzrlib import errors, urlutils
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
45
 
48
 
The --fixes option allows you to specify a bug tracker and a bug identifier
49
 
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::
50
48
 
51
49
    bzr commit --fixes <tracker>:<id>
52
50
 
58
56
use this feature, you just need to know the tracker identifier to use.
59
57
These are the bugtrackers that are built in:
60
58
 
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
 
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
  ============================ ============ ============
65
66
 
66
67
For the bug trackers not listed above configuration is required.
67
68
Support for generating the URLs for any project using Bugzilla or Trac
84
85
 
85
86
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
86
87
 
87
 
bugzilla_<tracker_abbreviation>_url
88
 
-----------------------------------
 
88
bugzilla_<tracker>_url
 
89
----------------------
89
90
 
90
91
If present, the location of the Bugzilla bug tracker referred to by
91
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
92
<tracker>. This option can then be used together with ``bzr commit
92
93
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
93
94
example::
94
95
 
97
98
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
98
99
fixed.
99
100
 
100
 
trac_<tracker_abbrevation>_url
101
 
------------------------------
 
101
trac_<tracker>_url
 
102
------------------
102
103
 
103
104
If present, the location of the Trac instance referred to by
104
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
105
<tracker>. This option can then be used together with ``bzr commit
105
106
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
106
107
example::
107
108
 
110
111
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
111
112
fixed.
112
113
 
113
 
bugtracker_<tracker_abbrevation>_url
114
 
------------------------------------
 
114
bugtracker_<tracker>_url
 
115
------------------------
115
116
 
116
117
If present, the location of a generic bug tracker instance referred to by
117
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
118
<tracker>. The location must contain an ``{id}`` placeholder,
118
119
which will be replaced by a specific bug ID. This option can then be used
119
120
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
120
121
fixed by that commit. For example::