/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: James Westby
  • Date: 2009-03-12 06:04:54 UTC
  • mto: This revision was merged to the branch mainline in revision 4139.
  • Revision ID: james.westby@canonical.com-20090312060454-f04pmpufns32zyk6
Move the shelve docs from bzrtools to the main help.

Also change them to document the new "shelve" rather than the old one.

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