<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Bug trackers — Bazaar 2.6.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/bzr.ico"/>
<link rel="top" title="Bazaar 2.6.0 documentation" href="../index.html" />
<link rel="up" title="Bazaar User Guide" href="index.html" />
<link rel="next" title="Specifying revisions" href="specifying_revisions.html" />
<link rel="prev" title="Web browsing" href="web_browsing.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="specifying_revisions.html" title="Specifying revisions"
accesskey="N">next</a></li>
<li class="right" >
<a href="web_browsing.html" title="Web browsing"
accesskey="P">previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="../_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li><a href="../index.html">Table of Contents (2.6.0)</a> »</li>
<li><a href="index.html" accesskey="U">Bazaar User Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="bug-trackers">
<h1>Bug trackers<a class="headerlink" href="#bug-trackers" title="Permalink to this headline">¶</a></h1>
<p>Bazaar has a facility that allows you to associate a commit with a bug
in the project’s bug tracker. Other tools (or hooks) can then use this
information to generate hyperlinks between the commit and the bug, or to
automatically mark the bug closed in the branches that contain the commit.</p>
<div class="section" id="associating-commits-and-bugs">
<h2>Associating commits and bugs<a class="headerlink" href="#associating-commits-and-bugs" title="Permalink to this headline">¶</a></h2>
<p>When you make a commit, you can associate it with a bug by using the
<tt class="docutils literal"><span class="pre">--fixes</span></tt> option of <tt class="docutils literal"><span class="pre">commit</span></tt>. For example:</p>
<div class="highlight-python"><div class="highlight"><pre>$ bzr commit --fixes lp:12345 -m "Properly close the connection"
</pre></div>
</div>
<p>This records metadata in Bazaar linking the commit with bug 12345 in
Launchpad. If you use a different bug tracker, it can be given its own
tracker code (instead of <tt class="docutils literal"><span class="pre">lp</span></tt>) and used instead. For details on how
to configure this for Bugzilla, Trac, Roundup and other bug/issue trackers,
refer to <a class="reference external" href="../user-reference/index.html#bug-tracker-settings">Bug Tracker Settings</a> in the Bazaar User Reference.</p>
</div>
<div class="section" id="metadata-recording-vs-bug-tracker-updating">
<h2>Metadata recording vs bug tracker updating<a class="headerlink" href="#metadata-recording-vs-bug-tracker-updating" title="Permalink to this headline">¶</a></h2>
<p>Recording metadata about bugs fixed at commit time is only
one of the features needed for complete bug tracker integration.
As Bazaar is a distributed VCS, users may be offline while committing
so accessing the bug tracker itself at that time may not be possible.
Instead, it is recommended that a hook be installed to update
the bug tracker when changes are pushed to a central location
appropriate for your project’s workflow.</p>
<p>Note: This second processing stage is part of the integration provided
by Launchpad when it scans external or hosted branches.</p>
</div>
<div class="section" id="making-corrections">
<h2>Making corrections<a class="headerlink" href="#making-corrections" title="Permalink to this headline">¶</a></h2>
<p>This method of associating revisions and bugs does have some limitations. The
first is that the association can only be made at commit time. This means that
if you forget to make the association when you commit, or the bug is reported
after you fix it, you generally cannot go back and add the link later.</p>
<p>Related to this is the fact that the association is immutable. If a bug is
marked as fixed by one commit but that revision does not fully solve the
bug, or there is a later regression, you cannot go back and remove the link.</p>
<p>Of course, <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">uncommit</span></tt> can always be used to undo the last commit in
order to make it again with the correct options. This is commonly done
to correct a bad commit message and it equally applies to correcting
metadata recorded (via <tt class="docutils literal"><span class="pre">--fixes</span></tt> for example) on the last commit.</p>
<p>Note: <tt class="docutils literal"><span class="pre">uncommit</span></tt> is best done before incorrect revisions become public.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Bug trackers</a><ul>
<li><a class="reference internal" href="#associating-commits-and-bugs">Associating commits and bugs</a></li>
<li><a class="reference internal" href="#metadata-recording-vs-bug-tracker-updating">Metadata recording vs bug tracker updating</a></li>
<li><a class="reference internal" href="#making-corrections">Making corrections</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="web_browsing.html"
title="previous chapter">Web browsing</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="specifying_revisions.html"
title="next chapter">Specifying revisions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-guide/bug_trackers.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="specifying_revisions.html" title="Specifying revisions"
>next</a></li>
<li class="right" >
<a href="web_browsing.html" title="Web browsing"
>previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="../_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li><a href="../index.html">Table of Contents (2.6.0)</a> »</li>
<li><a href="index.html" >Bazaar User Guide</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2011 Canonical Ltd.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
