← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-09 15:09:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3699.
  • Revision ID: john@arbash-meinel.com-20080909150912-wyttm8he1zsls2ck
Use the right timing function on win32

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
42
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
 
     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
63
 
 
64
 
For the bug trackers not listed above configuration is required.
65
 
Support for generating the URLs for any project using Bugzilla or Trac
66
 
is built in, along with a template mechanism for other bugtrackers with
67
 
simple URL schemes. If your bug tracker can't be described by one
68
 
of the schemes described below then you can write a plugin to support
69
 
it.
70
 
 
 
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.
71
54
If you use Bugzilla or Trac, then you only need to set a configuration
72
55
variable which contains the base URL of the bug tracker. These options
73
56
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
77
60
Note: As you provide a short name for each tracker, you can specify one or
78
61
more bugs in one or more trackers at commit time if you wish.
79
62
 
80
 
Launchpad
81
 
---------
82
 
 
83
 
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
84
 
 
85
63
bugzilla_<tracker_abbreviation>_url
86
64
-----------------------------------
87
65
 
280
258
 
281
259
 
282
260
tracker_registry.register('generic', GenericBugTracker())
283
 
 
284
 
 
285
 
FIXED = 'fixed'
286
 
 
287
 
ALLOWED_BUG_STATUSES = set([FIXED])
288
 
 
289
 
 
290
 
def encode_fixes_bug_urls(bug_urls):
291
 
    """Get the revision property value for a commit that fixes bugs.
292
 
 
293
 
    :param bug_urls: An iterable of escaped URLs to bugs. These normally
294
 
        come from `get_bug_url`.
295
 
    :return: A string that will be set as the 'bugs' property of a revision
296
 
        as part of a commit.
297
 
    """
298
 
    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)