/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 doc/en/user-guide/bug_trackers.txt

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
============
2
 
Bug Trackers
3
 
============
 
1
Integrating Bazaar with bug trackers
 
2
====================================
4
3
 
5
4
Bazaar has a facility that allows you to associate a commit with a bug
6
5
in the project's bug tracker. Other tools can then use this information
7
6
to link between the commit and the bug, or to automatically mark the bug
8
7
closed in the branches that contain the commit.
9
8
 
10
 
Associating Commits and Bugs
11
 
============================
 
9
Associating commits and bugs
 
10
----------------------------
12
11
 
13
12
When you make a commit you can assiociate it with a bug by using the
14
13
``--fixes`` option of ``commit``. For example::
15
14
 
16
 
    $ bzr commit --fixes 12345 -m 'Properly close the connection on errors'
 
15
    $ bzr commit --fixes 12345 -m "Properly close the connection on errors"
17
16
 
18
17
This will set a revision property on the revision that is committed
19
18
which contains the URI at which more information on the bug can be found.
20
19
Bazaar itself does no more than this, but once the information is recorded
21
20
other tools can make use of it.
22
21
 
23
 
Configuration of the Bug Tracker
24
 
================================
 
22
Configuration of the bug tracker
 
23
--------------------------------
25
24
 
26
25
As each project has it's own bug tracker, and there are many different
27
26
bug tracking systems you must first do some configuration before you
41
40
can specify which you mean at commit time.
42
41
 
43
42
bugzilla_<tracker_abbreviation>_url
44
 
-----------------------------------
 
43
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
44
 
45
45
If present, the location of the Bugzilla bug tracker referred to by
46
46
<tracker_abbreviation>. This option can then be used together with ``bzr commit
47
47
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
53
53
fixed.
54
54
 
55
55
trac_<tracker_abbrevation>_url
56
 
------------------------------
 
56
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
57
 
57
58
If present, the location of the Trac instance referred to by
58
59
<tracker_abbreviation>. This option can then be used together with ``bzr commit
59
60
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
65
66
fixed.
66
67
 
67
68
Limitations of the system
68
 
=========================
 
69
-------------------------
69
70
 
70
71
This method of associating revisions and bugs does have some limitations. The
71
72
first is that the association can only be made at commit time. This means that