← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Mark Hammond
  • Date: 2009-01-12 01:55:34 UTC
  • mto: (3995.8.2 prepare-1.12)
  • mto: This revision was merged to the branch mainline in revision 4007.
  • Revision ID: mhammond@skippinet.com.au-20090112015534-yfxg50p7mpds9j4v
Include all .html files from the tortoise doc directory.

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import textwrap
16
18
 
17
19
from bzrlib import registry, help_topics
18
20
from bzrlib.lazy_import import lazy_import
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
 
 
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
 
 
 
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.
74
54
If you use Bugzilla or Trac, then you only need to set a configuration
75
55
variable which contains the base URL of the bug tracker. These options
76
56
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
85
65
 
86
66
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
87
67
 
88
 
bugzilla_<tracker>_url
89
 
----------------------
 
68
bugzilla_<tracker_abbreviation>_url
 
69
-----------------------------------
90
70
 
91
71
If present, the location of the Bugzilla bug tracker referred to by
92
 
<tracker>. This option can then be used together with ``bzr commit
 
72
<tracker_abbreviation>. This option can then be used together with ``bzr commit
93
73
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
94
74
example::
95
75
 
98
78
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
99
79
fixed.
100
80
 
101
 
trac_<tracker>_url
102
 
------------------
 
81
trac_<tracker_abbrevation>_url
 
82
------------------------------
103
83
 
104
84
If present, the location of the Trac instance referred to by
105
 
<tracker>. This option can then be used together with ``bzr commit
 
85
<tracker_abbreviation>. This option can then be used together with ``bzr commit
106
86
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
107
87
example::
108
88
 
111
91
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
112
92
fixed.
113
93
 
114
 
bugtracker_<tracker>_url
115
 
------------------------
 
94
bugtracker_<tracker_abbrevation>_url
 
95
------------------------------------
116
96
 
117
97
If present, the location of a generic bug tracker instance referred to by
118
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
98
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
119
99
which will be replaced by a specific bug ID. This option can then be used
120
100
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
121
101
fixed by that commit. For example::
283
263
 
284
264
 
285
265
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)