Differences between revisions 20 and 21
Revision 20 as of 2007-02-06 18:35:20
Size: 2158
Editor: i59F77EE2
Comment: we don't have '-a' anymore
Revision 21 as of 2007-02-12 21:50:57
Size: 591
Editor: 81
Comment: simplified
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
'''bughelper''' is a tool written and maintained by Ubuntu's BugSquad. '''bughelper''' is a tool written and maintained by Ubuntu's BugSquad to help triage bugs and share knowledge.
Line 3: Line 3:
== Download == == Documentation ==
Line 5: Line 5:
 * `bzr branch http://bazaar.launchpad.net/~bugsquad/bughelper/bughelper.main`
 * Other branches: https://launchpad.net/products/bughelper/+branches
 * Bughelper requires python-apt and python-libxml2
 1. '''[:/doc:Installing bughelper and getting started]'''
 1. '''[:/doc/options:Command line options]'''
 1. '''[:/doc/WritingClueFiles:Writing clue files]'''
 1. '''[:/doc/components:Bughelper components]
Line 11: Line 12:
 * [:/Dev]
 * https://lists.ubuntu.com/mailman/listinfo/bughelper

== Documentation ==

''You may want to start with the [:BugHelper/Tutorial:tutorial].''

Help on [:/Documentation/WritingClueFiles].

The suite currently contains:

=== ./bugnumbers ===

This tool collects bug numbers from Launchpad. You can pass it
 * `-V` which will return the version number of the bughelper suite
 * `-l <URL>` for a Launchpad bug list URL
 * a source package name like `evolution`

Examples: {{{
   bugnumbers -p evolution
   bugnumbers -l https://launchpad.net/distros/ubuntu/+source/gcalctool/+bugs

=== ./bughelper ===

This tool searches through bugs and tries to find matches with data in `.info` files. It has the same functionality and switches as `bugnumber`. In addition to that it accepts
 * `--version` which will return the version number of the bughelper suite
 * `-A` which lets it search through all the bug attachments with the mime type `text/plain`.
Examples: {{{
   bughelper -p ubiquity
   bughelper -A -l https://launchpad.net/distros/ubuntu/+source/gcalctool/+bugs

=== ./bugxml ===

This tool is primarily intended to help with the editing and creation of `.info` files. There are currently two use cases:
 * `-a <source package> <condition> <information>` adds a simple clue to an existing file or creates a new one.
 * `-e <string>` escapes a given string for use in XML files.
 * `-v <file>` validates a given file against the clue file schema.

Examples: {{{
   bugxml -a totem "libxine.so" "This might be a xine problem. Ask the reporter to check with xine-ui."
   bugxml -v packages/ubiquity.info
   bugxml -e This string has some weird characters like ä, ü and ö in it.
 1. [:/Dev:Development pages]
 1. [https://lists.ubuntu.com/mailman/listinfo/bughelper Mailing list]
 1. Join {{{#ubuntu-bugs}}} on IRC

bughelper is a tool written and maintained by Ubuntu's BugSquad to help triage bugs and share knowledge.


  1. [:/doc:Installing bughelper and getting started]

  2. [:/doc/options:Command line options]

  3. [:/doc/WritingClueFiles:Writing clue files]

  4. [:/doc/components:Bughelper components]

Development and Discussion

  1. [:/Dev:Development pages]

  2. [https://lists.ubuntu.com/mailman/listinfo/bughelper Mailing list]

  3. Join #ubuntu-bugs on IRC

Go back to [:BugSquad].BR [:CategoryBugSquad]

BugHelper (last edited 2008-12-01 07:09:42 by i59F771D5)