help for bugs is a bit bare

[Wouter van Heyst]

Related to 111703 (listing all known bugtrackers), `bzr help bugs` should point users at how to configure tracker aliases.

Also, some concrete usage information "bzr commit --fixes alias:1234" would help demistify.

[Patrick Regan (patrick-regan)]

Is this bug relevant anymore? This seems to be documented to me. It's possible that the documentation was updated and no one updated the status of this bug.

If more documentation is needed, please specify what is missing.

[Robert Collins (lifeless)]

There are still no concrete usage examples, and I think that they would help.

[Patrick Regan (patrick-regan)]

the output of "bzr help bugs" from version 2.0.2 is below. It seems to tell you exactly what to put in your *.conf file. Each type of tracker has it's own concrete example. For example, bugtracker is configured with "squid" as the alias.

I'm still not understanding what specifically needs to change. I'm sorry if I'm just being dense.

Output of "bzr help bugs":

Bug Tracker Settings

When making a commit, metadata about bugs fixed by that change can be
recorded by using the --fixes option. For each bug marked as fixed, an
entry is included in the 'bugs' revision property stating '<url> <status>'.
(The only ``status`` value currently supported is ``fixed.``)

The --fixes option allows you to specify a bug tracker and a bug identifier
rather than a full URL. This looks like

    bzr commit --fixes <tracker>:<id>

where "<tracker>" is an identifier for the bug tracker, and "<id>" is the
identifier for that bug within the bugtracker, usually the bug number.

Bazaar knows about a few bug trackers that have many users. If
you use one of these bug trackers then there is no setup required to
use this feature, you just need to know the tracker identifier to use.
These are the bugtrackers that are built in:

     URL | Abbreviation | Example
     https://bugs.launchpad.net/ | lp | lp:12345
     http://bugs.debian.org/ | deb | deb:12345
     http://bugzilla.gnome.org/ | gnome | gnome:12345

For the bug trackers not listed above configuration is required.
Support for generating the URLs for any project using Bugzilla or Trac
is built in, along with a template mechanism for other bugtrackers with
simple URL schemes. If your bug tracker can't be described by one
of the schemes described below then you can write a plugin to support
it.

If you use Bugzilla or Trac, then you only need to set a configuration
variable which contains the base URL of the bug tracker. These options
can go into ``bazaar.conf``, ``branch.conf`` or into a branch-specific
configuration section in ``locations.conf``. You can set up these values
for each of the projects you work on.

Note: As you provide a short name for each tracker, you can specify one or
more bugs in one or more trackers at commit time if you wish.

Launchpad
---------

Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2.

bugzilla_<tracker_abbreviation>_url
-----------------------------------

If present, the location of the Bugzilla bug tracker referred to by
<tracker_abbreviation>. This option can then be used together with ``bzr commit
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
example:

    bugzilla_squid_url = http://www.squid-cache.org/bugs

would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
fixed.

trac_<tracker_abbrevation>_url
------------------------------

If present, the location of the Trac instance referred to by
<tracker_abbreviation>. This option can then be used together with ``bzr commit
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
example:

    trac_twisted_url = http://www.twistedmatrix.com/trac

would allow ``bzr commit --fixes twiste...

[Robert Collins (lifeless)]

You are right, though the examples don't really stand out to me.