← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/bug_trackers.txt

Turn completion assertions into separate methods.

Many common assertions used to be expressed as arguments to the complete
method.  This makes the checks more explicit, and the code easier to read.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/bug_trackers.txt
1
 
Bug trackers
2
 
============
3
 
 
4
 
Bazaar has a facility that allows you to associate a commit with a bug
5
 
in the project's bug tracker. Other tools (or hooks) can then use this
6
 
information to generate hyperlinks between the commit and the bug, or to
7
 
automatically mark the bug closed in the branches that contain the commit.
8
 
 
9
 
Associating commits and bugs
10
 
----------------------------
11
 
 
12
 
When you make a commit, you can associate it with a bug by using the
13
 
``--fixes`` option of ``commit``. For example::
14
 
 
15
 
    $ bzr commit --fixes lp:12345 -m "Properly close the connection"
16
 
 
17
 
This records metadata in Bazaar linking the commit with bug 12345 in
18
 
Launchpad. If you use a different bug tracker, it can be given its own
19
 
tracker code (instead of ``lp``) and used instead. For details on how
20
 
to configure this for Bugzilla, Trac, Roundup and other bug/issue trackers,
21
 
refer to `Bug Tracker Settings`_ in the Bazaar User Reference.
22
 
 
23
 
.. _Bug Tracker Settings: ../user-reference/index.html#bug-tracker-settings
24
 
 
25
 
Metadata recording vs bug tracker updating
26
 
------------------------------------------
27
 
 
28
 
Recording metadata about bugs fixed at commit time is only
29
 
one of the features needed for complete bug tracker integration.
30
 
As Bazaar is a distributed VCS, users may be offline while committing
31
 
so accessing the bug tracker itself at that time may not be possible.
32
 
Instead, it is recommended that a hook be installed to update
33
 
the bug tracker when changes are pushed to a central location
34
 
appropriate for your project's workflow.
35
 
 
36
 
Note: This second processing stage is part of the integration provided
37
 
by Launchpad when it scans external or hosted branches.
38
 
 
39
 
Making corrections
40
 
------------------
41
 
 
42
 
This method of associating revisions and bugs does have some limitations. The
43
 
first is that the association can only be made at commit time. This means that
44
 
if you forget to make the association when you commit, or the bug is reported
45
 
after you fix it, you generally cannot go back and add the link later.
46
 
 
47
 
Related to this is the fact that the association is immutable. If a bug is
48
 
marked as fixed by one commit but that revision does not fully solve the
49
 
bug, or there is a later regression, you cannot go back and remove the link.
50
 
 
51
 
Of course, ``bzr uncommit`` can always be used to undo the last commit in
52
 
order to make it again with the correct options. This is commonly done
53
 
to correct a bad commit message and it equally applies to correcting
54
 
metadata recorded (via ``--fixes`` for example) on the last commit.
55
 
 
56
 
Note: ``uncommit`` is best done before incorrect revisions become public.