← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: Sabin Iacob
  • Date: 2009-03-23 14:59:43 UTC
  • mto: (4189.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4193.
  • Revision ID: iacobs@m0n5t3r.info-20090323145943-3s3p1px5q1rkh2e5
update FSF mailing address

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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import textwrap
18
18
 
43
43
"""When making a commit, metadata about bugs fixed by that change can be
44
44
recorded by using the --fixes option. For each bug marked as fixed, an
45
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
48
 
can be recorded.
49
 
 
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.
 
46
(The only ``status`` value currently supported is ``fixed.``)
 
47
 
 
48
The --fixes option allows you to specify a bug tracker and a bug identifier
 
49
rather than a full URL. This looks like
 
50
 
 
51
    bzr commit --fixes <tracker>:<id>
 
52
 
 
53
where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
 
54
identifier for that bug within the bugtracker, usually the bug number.
 
55
 
 
56
Bazaar knows about a few bug trackers that have many users. If
 
57
you use one of these bug trackers then there is no setup required to
 
58
use this feature, you just need to know the tracker identifier to use.
 
59
These are the bugtrackers that are built in:
 
60
 
 
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
 
65
 
 
66
For the bug trackers not listed above configuration is required.
 
67
Support for generating the URLs for any project using Bugzilla or Trac
 
68
is built in, along with a template mechanism for other bugtrackers with
 
69
simple URL schemes. If your bug tracker can't be described by one
 
70
of the schemes described below then you can write a plugin to support
 
71
it.
 
72
 
53
73
If you use Bugzilla or Trac, then you only need to set a configuration
54
74
variable which contains the base URL of the bug tracker. These options
55
75
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
59
79
Note: As you provide a short name for each tracker, you can specify one or
60
80
more bugs in one or more trackers at commit time if you wish.
61
81
 
 
82
Launchpad
 
83
---------
 
84
 
 
85
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
 
86
 
62
87
bugzilla_<tracker_abbreviation>_url
63
88
-----------------------------------
64
89
 
170
195
    """A style of bug tracker that exists in one place only, such as Launchpad.
171
196
 
172
197
    If you have one of these trackers then register an instance passing in an
173
 
    abbreviated name for the bug tracker and a base URL.
 
198
    abbreviated name for the bug tracker and a base URL. The bug ids are
 
199
    appended directly to the URL.
174
200
    """
175
201
 
176
202
    def __init__(self, abbreviated_bugtracker_name, base_url):
186
212
 
187
213
    def _get_bug_url(self, bug_id):
188
214
        """Return the URL for bug_id."""
189
 
        return urlutils.join(self.base_url, bug_id)
 
215
        return self.base_url + bug_id
190
216
 
191
217
 
192
218
tracker_registry.register(
197
223
    'debian', UniqueIntegerBugTracker('deb', 'http://bugs.debian.org/'))
198
224
 
199
225
 
 
226
tracker_registry.register('gnome',
 
227
    UniqueIntegerBugTracker('gnome', 'http://bugzilla.gnome.org/show_bug.cgi?id='))
 
228
 
 
229
 
200
230
class URLParametrizedIntegerBugTracker(IntegerBugTracker):
201
231
    """A type of bug tracker that can be found on a variety of different sites,
202
232
    and thus needs to have the base URL configured.
252
282
 
253
283
 
254
284
tracker_registry.register('generic', GenericBugTracker())
 
285
 
 
286
 
 
287
FIXED = 'fixed'
 
288
 
 
289
ALLOWED_BUG_STATUSES = set([FIXED])
 
290
 
 
291
 
 
292
def encode_fixes_bug_urls(bug_urls):
 
293
    """Get the revision property value for a commit that fixes bugs.
 
294
 
 
295
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
 
296
        come from `get_bug_url`.
 
297
    :return: A string that will be set as the 'bugs' property of a revision
 
298
        as part of a commit.
 
299
    """
 
300
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)