← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bugtracker.py

Merge description into dont-add-conflict-helpers

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bugtracker.py
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
 
     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
 
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
  ============================ ============ ============
63
66
 
64
67
For the bug trackers not listed above configuration is required.
65
68
Support for generating the URLs for any project using Bugzilla or Trac
82
85
 
83
86
Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.
84
87
 
85
 
bugzilla_<tracker_abbreviation>_url
86
 
-----------------------------------
 
88
bugzilla_<tracker>_url
 
89
----------------------
87
90
 
88
91
If present, the location of the Bugzilla bug tracker referred to by
89
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
92
<tracker>. This option can then be used together with ``bzr commit
90
93
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
91
94
example::
92
95
 
95
98
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
96
99
fixed.
97
100
 
98
 
trac_<tracker_abbrevation>_url
99
 
------------------------------
 
101
trac_<tracker>_url
 
102
------------------
100
103
 
101
104
If present, the location of the Trac instance referred to by
102
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
 
105
<tracker>. This option can then be used together with ``bzr commit
103
106
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
104
107
example::
105
108
 
108
111
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
109
112
fixed.
110
113
 
111
 
bugtracker_<tracker_abbrevation>_url
112
 
------------------------------------
 
114
bugtracker_<tracker>_url
 
115
------------------------
113
116
 
114
117
If present, the location of a generic bug tracker instance referred to by
115
 
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
 
118
<tracker>. The location must contain an ``{id}`` placeholder,
116
119
which will be replaced by a specific bug ID. This option can then be used
117
120
together with ``bzr commit --fixes`` to mark bugs in that tracker as being
118
121
fixed by that commit. For example::