Diff for "ReportingBugs"


Differences between revisions 174 and 175
Revision 174 as of 2012-05-06 17:14:29
Size: 14797
Editor: dynamic-adsl-78-14-229-161
Comment: updated link to italian translation
Revision 175 as of 2012-05-18 05:56:03
Size: 15183
Editor: 140
Comment: Added note about how do not apport-collect unless O.R. or asked == Adding Apport Debug Information to an Existing Launchpad Bug ==
Deletions are marked like this. Additions are marked like this.
Line 174: Line 174:
If you have already reported a bug directly via Launchpad, but want to add additional debugging information via ''Apport'' to the bug report, you can do this by running the command `apport-collect bug_number` via "Run Application" or terminal window. If you have already reported a bug directly via Launchpad, but want to add additional debugging information via ''Apport'' to the bug report, you can do this by running the command `apport-collect bug_number` via "Run Application" or terminal window. If you are not the original reporter, please do not apport-collect to a bug report unless specifically asked of you by a developer or triager. Running apport-collect when not asked creates spammy E-Mail traffic for those subscribed, clutters up the bug report with undesired attachments, and hinders the bug getting addressed quickly. Instead, please open a new report via ubuntu-bug.

How to report bugs

Ubuntu uses Launchpad to keep track of bugs and their fixes. This page will guide you through the steps required to file a good and detailed report.

Using Kubuntu?

If you use Kubuntu, please see the Kubuntu variant of this page here.

1. Create a Launchpad account

If you don't already have one - you need to create a Launchpad account. This will allow you to file new bugs and comment on existing ones.

2. Determine if the bug is really a bug

You should not file a bug if you are:

Warning /!\ If you want to file a translation or misspelling bug, follow the instructions here.

3. Make sure the bug hasn't already been reported

When filing a bug, please make sure it has not already been reported by searching through the existing bugs and the release notes for your version of Ubuntu:

If you have further information about an already reported bug, add this information to the existing report, rather than opening a new one.

Warning /!\ For sound, X drivers, and kernel bugs: please open a new bug instead of commenting on a similar bug: chances are that your hardware does not match the existing bug's hardware, so the bug will not be addressed.

Back to top

4. Collect information about the bug

The method for reporting bugs in Ubuntu is by using the tool "ubuntu-bug", otherwise known as Apport. When reporting a bug, you must tell Apport which program or package is at fault.

Collecting information from a specific package

Filing a bug with the "Run Application" window

Press Alt+F2 to open the "Run Application" window, pictured above. Type ubuntu-bug <package name> and click Run. If you're not sure which package has the problem, refer to the instructions for finding the right package.

Collecting information about a program with a window open

If you want to file a bug about an application but you don't know what that application's package name is, if it has an open window you are in luck.

In a terminal execute the command 'ubuntu-bug -w'.

terminal with ubuntu-bug -w

After you close the dialog the next window that you click on will have a problem report created for the package that created the window.

Collecting information from a currently running program

To file a bug against a program that is currently running, go to System > Administration > System Monitor, and find the ID of the process.

System Monitor Processes tab

Then type "ubuntu-bug " followed by the process ID into the "Run Application" window.

Filing a bug with the "Run Application" window and a process ID

Filing a general bug against no particular package

If you're not sure which package is affected by the bug, type ubuntu-bug in the "Run Application" window and click Run. This will guide you through a series of questions to gather more information about the bug.

Back to top

5. Complete the bug report filing process

After running one of the above commands, Apport (the Ubuntu bug reporter) will gather information about the bug.

Apport collecting information about the bug

A window will then pop up, asking you if you want to report the bug. Click "Send Report" if you wish to proceed, or click "Content of the report" if you want to review the information Apport collected.

Apport asking you to send the report

Apport will then upload the problem information to Launchpad, and a new browser window will then open to inform you that the bug report is being processed.

Apport uploading the problem information

Launchpad processing the bug report data

After the bug report data has been processed, a new page will open that will ask you for the bug report's title. The bug title will appear in all bug listings so make sure it represents the bug well. When you're done, click "Next".

Launchpad asking for a bug title

A search will then occur based on the title you gave to the bug report, and will show potentially similar ones. If one of these seems to be the exact bug you're reporting, click its title, then "Yes, this is the bug I'm trying to report". If not, click "No, I need to report a new bug".

Launchpad search results about the bug title

Launchpad will then ask you for further information. It's important that you specify three things:

  1. What you expected to happen
  2. What actually happened
  3. If possible, a minimal series of steps necessary to make it happen, where step 1 is "start the program"

Fill in the description field with as much information as you can, it is better to have too much information in the description than not enough.

Launchpad asking for further information

At then bottom of the page, there are some extra options you can use to make your bug report more complete:

  • This bug is a security vulnerability: Please check this only if your bug report describes a behaviour that could be exploited to crack your system. (TODO: better wording?)

  • Tags: You can add here tags that pertain to your bug report. The predefined values should be left alone.

  • Include an attachment: Using this option, you can add supporting attachments to explain or help others reproduce the bug. This might include a screenshot, a video capture of the problem or a sample document that triggers the fault. Additional attachments, if necessary, can be added after the bug is reported via Add a comment/attachment at the bottom of the page.

Launchpad presenting extra options

When you're done, click "Submit bug report".

Tips and tricks

Filing bugs when off-line

In the event that you have an issue with your Internet connection or want to file a bug for another system you can still do this using apport.

First, gather the information about the target system in a file:

  • For a bug report about a system crash:
    apport-cli -p <package name> --save bug.crash

  • For a bug report about any other issue:
    apport-cli -f -p <package name> --save bug.apport

You will need to answer a few questions, which will vary depending on which package the bug report is about. Relevant system information, including the package name, is then saved on the target system, in the current directory. The extension indicates if it is a crash report or another kind of report. If you decide to rename the report file, please keep the .apport or .crash extension.

After copying it to a different system you can file that report using the following command:
ubuntu-bug -c <apport_file.extension>

If this is to be added to an existing bug report, also use the -u option:
ubuntu-bug -c <apport_file.extension> -u <bug number>

You will need to answer a few questions, and a web browser will be launched to complete the bug report.

Filing bugs at Launchpad.net

If for some reason you cannot file a bug using the Apport tool you can file one via Launchpad's own bug report form. When doing so it is best if you have determined which package it should be filed against. Read 'finding the right package' for guidance or use Launchpad's package search feature. We don't recommend this method for most bug reports because they will likely be missing crucial information, use ubuntu-bug if you can!

To file a bug against a specific package you can also use a URL like the following:

  • http://bugs.launchpad.net/ubuntu/+source/PACKAGENAME/+filebug?no-redirect

where PACKAGENAME is the name of the source package about which you want to file the bug report.

In the event that you want to request a piece of software be packaged for Ubuntu please follow the instructions in the wiki.

Using the help menu in the affected application (development releases only)

If you want to report a bug on an application that is running and responding, use the application's help menu: Help -> Report a problem.

report-a-problem.png

This method is preferable to filing a bug at the Launchpad website - it will automatically attach relevant information, which helps analyze the problem.

If an application crashes, and you're using a version of Ubuntu which is actively under development, Apport will start automatically, raising an appropriate bug report for you to complete in Launchpad. This provides developers with rich debugging information that will make it easier to fix the problem.

apport-1.png

Adding Apport Debug Information to an Existing Launchpad Bug

If you have already reported a bug directly via Launchpad, but want to add additional debugging information via Apport to the bug report, you can do this by running the command apport-collect bug_number via "Run Application" or terminal window. If you are not the original reporter, please do not apport-collect to a bug report unless specifically asked of you by a developer or triager. Running apport-collect when not asked creates spammy E-Mail traffic for those subscribed, clutters up the bug report with undesired attachments, and hinders the bug getting addressed quickly. Instead, please open a new report via ubuntu-bug.

Filing a translation bug

You should file a translation bug if you are experiencing one of the following issues:

  • Wrong translations or spelling mistakes for languages other than English in applications
  • Errors in spellcheckers or language support
  • A string from an application not available for translation in Launchpad Translations

  • An application from the Ubuntu main repository not available for translation in Launchpad Translations

  • A translation made in Launchpad Translations and not updated in the Ubuntu language packs

  • A duplicate translation template (the same application can be translated in two different places) in Launchpad Translations

  • A template/translation no longer used in Ubuntu and that should be disabled from Launchpad Translations

In case of doubt, you can always contact the Translations team.

All translation issues should be filed against the Ubuntu Translations project. From there the bugs will be triaged and assigned to the right person and package.

Back to top

Getting advice

Still have doubts about the bug report filing process? You can ask someone on #ubuntu-bugs on the Freenode IRC server or on the bugsquad mailing list.

Back to top

Other languages

Back to top

See Also

ReportingBugs (last edited 2023-06-06 17:23:38 by nio-wiklund)