← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

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
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
 
from bzrlib import registry
 
17
from bzrlib import registry, help_topics
18
18
from bzrlib.lazy_import import lazy_import
19
19
lazy_import(globals(), """
20
20
from bzrlib import errors, urlutils
39
39
 
40
40
_bugs_help = \
41
41
"""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
 
42
recorded by using the --fixes option. For each bug marked as fixed, an
43
43
entry is included in the 'bugs' revision property stating '<url> <status>'.
44
44
(The only ``status`` value currently supported is ``fixed.``)
45
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::
 
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
48
 
49
49
    bzr commit --fixes <tracker>:<id>
50
50
 
56
56
use this feature, you just need to know the tracker identifier to use.
57
57
These are the bugtrackers that are built in:
58
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
 
  ============================ ============ ============
 
59
     URL                          | Abbreviation | Example
 
60
     https://bugs.launchpad.net/  | lp           | lp:12345
 
61
     http://bugs.debian.org/      | deb          | deb:12345
 
62
     http://bugzilla.gnome.org/   | gnome        | gnome:12345
66
63
 
67
64
For the bug trackers not listed above configuration is required.
68
65
Support for generating the URLs for any project using Bugzilla or Trac
85
82
 
86
83
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
87
84
 
88
 
bugzilla_<tracker>_url
89
 
----------------------
 
85
bugzilla_<tracker_abbreviation>_url
 
86
-----------------------------------
90
87
 
91
88
If present, the location of the Bugzilla bug tracker referred to by
92
 
<tracker>. This option can then be used together with ``bzr commit
 
89
<tracker_abbreviation>. This option can then be used together with ``bzr commit
93
90
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
94
91
example::
95
92
 
98
95
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
99
96
fixed.
100
97
 
101
 
trac_<tracker>_url
102
 
------------------
 
98
trac_<tracker_abbrevation>_url
 
99
------------------------------
103
100
 
104
101
If present, the location of the Trac instance referred to by
105
 
<tracker>. This option can then be used together with ``bzr commit
 
102
<tracker_abbreviation>. This option can then be used together with ``bzr commit
106
103
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
107
104
example::
108
105
 
111
108
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
112
109
fixed.
113
110
 
114
 
bugtracker_<tracker>_url
115
 
------------------------
 
111
bugtracker_<tracker_abbrevation>_url
 
112
------------------------------------
116
113
 
117
114
If present, the location of a generic bug tracker instance referred to by
118
 
<tracker>. The location must contain an ``{id}`` placeholder,
 
115
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
119
116
which will be replaced by a specific bug ID. This option can then be used
120
117
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
121
118
fixed by that commit. For example::