/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

  • Committer: Martin Pool
  • Date: 2005-06-28 03:02:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050628030231-d311e4ebcd467ef4
Merge John's import-speedup branch:

                                                                                         
  777 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:32 -0500
      revision-id: john@arbash-meinel.com-20050627032031-e82a50db3863b18e
      bzr selftest was not using the correct bzr

  776 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:22 -0500
      revision-id: john@arbash-meinel.com-20050627032021-c9f21fde989ddaee
      Add was using an old mutter

  775 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:02:33 -0500
      revision-id: john@arbash-meinel.com-20050627030233-9165cfe98fc63298
      Cleaned up to be less different

  774 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:54:53 -0500
      revision-id: john@arbash-meinel.com-20050627025452-4260d0e744edef43
      Allow BZR_PLUGIN_PATH='' to negate plugin loading.

  773 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:49:34 -0500
      revision-id: john@arbash-meinel.com-20050627024933-b7158f67b7b9eae5
      Finished the previous cleanup (allowing load_plugins to be called twice)

  772 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:45:08 -0500
      revision-id: john@arbash-meinel.com-20050627024508-723b1df510d196fc
      Work on making the tests pass. versioning.py is calling run_cmd directly, but plugins have been loaded.

  771 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:32:29 -0500
      revision-id: john@arbash-meinel.com-20050627023228-79972744d7c53e15
      Got it down a little bit more by removing import of tree and inventory.

  770 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:26:05 -0500
      revision-id: john@arbash-meinel.com-20050627022604-350b9773ef622f95
      Reducing the number of import from bzrlib/__init__.py and bzrlib/branch.py

  769 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:32:25 -0500
      revision-id: john@arbash-meinel.com-20050627013225-32dd044f10d23948
      Updated revision.py and xml.py to include SubElement.

  768 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:56 -0500
      revision-id: john@arbash-meinel.com-20050627010356-ee66919e1c377faf
      Minor typo

  767 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:13 -0500
      revision-id: john@arbash-meinel.com-20050627010312-40d024007eb85051
      Caching the import

  766 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:51:47 -0500
      revision-id: john@arbash-meinel.com-20050627005147-5281c99e48ed1834
      Created wrapper functions for lazy import of ElementTree

  765 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:46:37 -0500
      revision-id: john@arbash-meinel.com-20050627004636-bf432902004a94c5
      Removed all of the test imports of cElementTree

  764 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:43:59 -0500
      revision-id: john@arbash-meinel.com-20050627004358-d137fbe9570dd71b
      Trying to make bzr startup faster.

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.