[Community Ubuntu Documentation] Update of "ReportingBugs" by ilidrissi.amine

Help Ubuntu webmaster at ubuntu.com
Thu Sep 23 20:03:36 BST 2010


Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Community Ubuntu Documentation" for change notification.

The following page has been changed by ilidrissi.amine:
http://help.ubuntu.com/community/ReportingBugs?action=diff&rev1=146&rev2=147

The comment on the change is:
Complete rewrite of the ReportingBugs page. Discussed by the BugSquad/BugControl teams extensively. - Mohamed Amine IL Idrissi

------------------------------------------------------------------------------
  
  <<Anchor(Top)>>
  
- '''If you've come here when trying to file a bug about Ubuntu in Launchpad this was deliberate.  Please read the following documentation regarding how to report a bug about Ubuntu.'''
+ = How to report bugs =
  
- = Reporting bugs =
+ ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents(3)>>||
  
- ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents(2)>>||
+ 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.
  
- Ubuntu uses Launchpad to keep track of bugs and their fixes. To file a bug you first need to [[ https://help.launchpad.net/YourAccount/NewAccount | create an account ]].  Once you have an account you can use the tools we've provided you on your Ubuntu system to file bug reports.
+ == Using Kubuntu? ==
  
- Note 1: If you use Kubuntu, please see the Kubuntu variant of this page [[https://wiki.kubuntu.org/Kubuntu/Bugs/Reporting|here]].
+ If you use Kubuntu, please see the Kubuntu variant of this page [[https://wiki.kubuntu.org/Kubuntu/Bugs/Reporting|here]].
  
- Note 2: After the bug is reported, please '''always''' leave the Status set to ''New'' (Curious about bug status? Details [[https://wiki.ubuntu.com/Bugs/Status|here]]).
+ == 1. Create a Launchpad account ==
  
- == Filing a bug with ubuntu-bug ==
+ If you don't already have one - you need to [[https://help.launchpad.net/YourAccount/NewAccount|create a Launchpad account]]. This will allow you to file new bugs and comment on existing ones.
  
- === Ubuntu 8.10 and later ===
+ == 2. Determine if your bug is really a bug ==
  
- ||<style="border: 0px solid black">{{attachment:ubuntu-bug.png|Filing a bug with the "Run Application" window}}||
+ You should not file a bug if you are:
  
+  * '''Requesting new software:''' you should follow the guidelines at https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages
+  * '''Requesting support:''' there are a multitude of ways you can get support, such as the [[https://answers.launchpad.net/ubuntu|Launchpad answer tracker]], the [[http://www.ubuntuforums.org/|Ubuntu forums]], the [[irc://irc.freenode.net/#ubuntu|#ubuntu]] channel on the [[https://help.ubuntu.com/community/InternetRelayChat|Freenode IRC]] server, the [[http://lists.ubuntu.com/mailman/listinfo/ubuntu-users|ubuntu-users]] mailing list, and the [[http://ubuntu.stackexchange.com|Ubuntu Stack Exchange]] site.
+  * '''Discussing features and existing policy:''' this belongs to the [[http://lists.ubuntu.com/mailman/listinfo/ubuntu-devel-discuss|ubuntu-devel-discuss]] mailing list.
+  * '''Proposing features and ideas:''' you should submit your idea to [[http://brainstorm.ubuntu.com/|Ubuntu Brainstorm]] or to the [[http://lists.ubuntu.com/mailman/listinfo/ubuntu-devel-discuss|ubuntu-devel-discuss]] mailing list.
+  * '''Filing a bug against a program not provided by an Ubuntu package:''' You should file a bug in that program's bug tracking interface. Instructions are generally available on the program's web site.
+ 
+ /!\ If you want to file a translation or misspelling bug, follow the instructions [[#translation|here]].
+  
+ == 3. Make sure your bug hasn't already been reported ==
+ 
+ When filing a bug, please make sure it has not already been reported by searching through the [[https://launchpad.net/distros/ubuntu/+bugs|existing bugs]] and the release notes for your version of Ubuntu:
+  * [[https://wiki.ubuntu.com/DapperReleaseNotes| Ubuntu 6.06 LTS (Dapper Drake)]]
+  * [[http://www.ubuntu.com/getubuntu/releasenotes/804|Ubuntu 8.04 LTS (Hardy Heron)]]
+  * [[http://www.ubuntu.com/getubuntu/releasenotes/904|Ubuntu 9.04 (Jaunty Jackalope)]]
+  * [[http://www.ubuntu.com/getubuntu/releasenotes/910|Ubuntu 9.10 (Karmic Koala)]]
+  * [[http://www.ubuntu.com/getubuntu/releasenotes/1004|Ubuntu 10.04 LTS (Lucid Lynx)]] 
+ 
+ If you have further information about an already reported bug, add this information to the existing report, rather than opening a new one.
+ 
+ /!\ '''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 your bug will not be addressed.
+ 
+ [[#Top|Back to top]]
+ 
+ == 4. Collect information about the bug ==
+ 
+ The method of 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 [[https://help.ubuntu.com/community/InstallingSoftware#What%20is%20a%20package?|package]] is at fault.
+ 
+ === Collecting information from a specific package ===
+ 
+ ||<style="border: 1px solid black">{{attachment:ubuntu-bug.png|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''.  Server Edition users should use a terminal instead.  If you're not sure which package has a problem,
+ 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 [[https://wiki.ubuntu.com/Bugs/FindRightPackage|finding the right package]].
  
- To file a bug against a program that is currently running, go to '''System > Administration > System Monitor''', and find the ID of the process.  Server Edition users should use `ps aux`.
+ === 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.
+ 
- {{attachment:system-monitor-id.png | System Monitor Processes tab }}
+ ||<style="border: 1px solid black">{{attachment:system-monitor-id.png | System Monitor Processes tab }}||
  
  Then type the process ID instead of the package name into the "Run Application" window.
  
- {{attachment:ubuntu-bug-pid.png | Filing a bug with the "Run Application" window and a process ID}}
+ ||<style="border: 1px solid black">{{attachment:ubuntu-bug-pid.png | Filing a bug with the "Run Application" window and a process ID}}||
  
- === Ubuntu 8.04 LTS to Ubuntu 9.04 ===
+ === Filing a general bug against no particular package ===
  
- In Ubuntu 8.04 LTS, you need to type `ubuntu-bug -p` (lowercase `p`) when reporting a bug about a package, or `ubuntu-bug -P` (capital `P`) when reporting a bug about a process ID.  Instructions are otherwise identical to the above.
+ 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 your bug.
  
- === Ubuntu 9.10 and Later ===
+ [[#Top|Back to top]]
  
- You only need to type `ubuntu-bug PKGNAME` when reporting against a package, or `ubuntu-bug PID` when reporting a bug about a process ID.  Instructions are otherwise identical to the above.
+ == 5. Complete the bug filing process ==
+ 
+ After running one of the above commands, Apport (the Ubuntu bug reporter) will gather information about your bug.
+ 
+ ||<style="border: 1px solid black">{{attachment:apport-1.png | 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.
+ 
+ ||<style="border: 1px solid black">{{attachment:send-problem-question.png | 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 is being processed.
+ 
+ ||<style="border: 1px solid black">{{attachment:information-upload.png | Apport uploading the problem information}}||
+ 
+ ||<style="border: 1px solid black">{{attachment:process-data.png | Launchpad processing the bug data}}||
+ 
+ After the bug data has been processed, a new page will open that will ask you for the bug's title. When you're done, click "Next".
+ 
+ ||<style="border: 1px solid black">{{attachment:bug-title.png | Launchpad asking for a bug title}}||
+ 
+ A search will then occur based on the title you gave to the bug, 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".
+ 
+ ||<style="border: 1px solid black">{{attachment:bug-search.png | 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
+  1. What actually happened
+  1. The 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, including the release of Ubuntu you are using and steps for someone else to recreate the bug.  It is better to have too much information in the description than not enough.
+ 
+ ||<style="border: 1px solid black">{{attachment:more-informations.png | Launchpad asking for further information}}||
+ 
+ At then bottom of the page, there is 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 [[http://wiki.ubuntu.com/Bugs/Tags|tags]] that pertain to your bug report. The predefined values are fine most of the time.
+  * '''Include an attachment:''' Using this option, you can add supporting attachments to explain or help others reproduce your 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.
+ 
+ ||<style="border: 1px solid black">{{attachment:extra-options.png | 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 a bug with your internet connection or want to file a bug for another system you can still do this using apport.  Using the command `apport-cli -f -p` ''`<package name>`'' on the target system will collect information and provide you with an option to "K: Keep report file for sending later or copying to somewhere else".  The report is then saved on the target system, in your ''/tmp'' directory which is cleared out on reboot,  with a .apport extension.  After copying it to a different system you can file that report using `ubuntu-bug ` ''`<location of apport file>`''.
+ 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.  Using the command `apport-cli -f -p` ''`<package name>`'' on the target system will collect information and provide you with an option to "K: Keep report file for sending later or copying to somewhere else".  The report is then saved on the target system, in your ''/tmp'' directory which is cleared out on reboot,  with a .apport extension.  After copying it to a different system you can file that report using `ubuntu-bug ` ''`<location of apport file>`''.
  
  == Filing bugs at Launchpad.net ==
  
- If for some reason you cannot file a bug through the ''Apport'' tool you can file one via [[https://bugs.launchpad.net/ubuntu/+filebug/?no-redirect | Launchpads own bug report form]]. When doing so it is best if you have determined which package it should be filed against. Read '[[http://wiki.ubuntu.com/Bugs/FindRightPackage|finding the right package]]' for guidance or use [[ http://launchpad.net/ubuntu/ | Launchpad's package search feature ]].
+ If for some reason you cannot file a bug using the ''Apport'' tool you can file one via [[https://bugs.launchpad.net/ubuntu/+filebug/?no-redirect | Launchpads own bug report form]]. When doing so it is best if you have determined which package it should be filed against. Read '[[http://wiki.ubuntu.com/Bugs/FindRightPackage|finding the right package]]' for guidance or use [[ http://launchpad.net/ubuntu/ | Launchpad's package search feature ]].
  
  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.  In the event that you want to request a piece of software be packaged for Ubuntu please follow the instructions in the [[ https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages#Requesting%20a%20new%20package%20for%20Ubuntu | wiki ]].
+ where PACKAGENAME is the name of the source package about which you want to file the bug.  
  
- == Using the help menu in the affected application ==
+ In the event that you want to request a piece of software be packaged for Ubuntu please follow the instructions in the [[ https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages#Requesting%20a%20new%20package%20for%20Ubuntu | wiki ]].
  
- '''Note:''' Since [[https://wiki.ubuntu.com/LucidLynx|10.04]] this only works for the Development Releases, If you're running Lucid you might want to use the [[https://help.ubuntu.com/community/ReportingBugs#Filing%20a%20bug%20with%20ubuntu-bug|ubuntu-bug]] method. (See [[https://wiki.ubuntu.com/DesktopTeam/Specs/Lucid/BugHandling|Lucid/BugHandling]] for information on this change.)
+ == 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'''.
  
@@ -68, +145 @@

  
  If an application crashes, and you're using a version of Ubuntu which is actively under development, [[https://wiki.ubuntu.com/Apport|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.
  
- {{attachment:apport-1.png}}
+ ||<style="border: 1px solid black">{{attachment:apport-1.png}}||
  
+ == Adding Apport Debug Information to an Existing Launchpad Bug ==
  
- == Filing translation bugs ==
+ If you have already reported a bug directly via Launchpad, but want to add additional debugging information via ''Apport'' to the bug, you can do this by running the command `apport-collect bug_number` via "Run Application" or terminal window.
  
- All translation issues should be filed against the [[https://bugs.launchpad.net/ubuntu-translations | Ubuntu Translations project]] (ubuntu-translations). From there the bugs will be triaged and assigned to the right person and package.
+ <<Anchor(translation)>>
+ == Filing a translation bug ==
  
- Here is a non-exhaustive list of problems that are appropriate for the Ubuntu Translations project:
+ You should file a translation bug if you are experiencing one of the following issues:
  
-  * Wrong translations or spelling mistakes in applications
+  * Wrong translations or spelling mistakes for languages other than English in applications
   * Errors in spellcheckers or language support 
-  * A string from an application is not available for translation in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
+  * A string from an application not available for translation in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
-  * An application from the Ubuntu main repository is not available for translation in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
+  * An application from the Ubuntu main repository not available for translation in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
-  * A translation made in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]] is not updated in the Ubuntu language packs
+  * A translation made in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]] and not updated in the Ubuntu language packs
-  * There is a duplicate translation template (the same application can be translated in two different places) in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
+  * A duplicate translation template (the same application can be translated in two different places) in [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
-  * A template/translation is no longer used in Ubuntu and should be disabled from [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
+  * A template/translation no longer used in Ubuntu and that should be disabled from [[http://translations.launchpad.net/ubuntu|Launchpad Translations]]
+ In case of doubt, you can always [[http://wiki.ubuntu.com/Translations/Contact|contact the Translations team]].
  
+ All translation issues should be filed against the [[https://bugs.launchpad.net/ubuntu-translations | Ubuntu Translations project]]. From there the bugs will be triaged and assigned to the right person and package.
- You can also consult the [[https://bugs.launchpad.net/ubuntu-translations|current bugs]] to see the big picture. In case of doubt, you can always [[http://wiki.ubuntu.com/Translations/Contact|contact the Translations team]].
- 
- === 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, you can do this by running the command `apport-collect bug_number` via "Run Application" or terminal window. If this fails then run `apport-collect -p <package name> bug_number`.
-  
- [[#Top|Back to top]]
- = Writing a useful report =
- 
- When a developer fixes a bug, they will test that the bug occurs, make a small change to the program, then see if the bug has gone away.  Depending on the bug, they might need to run the same test dozens or hundreds of times.  When you submit a bug report, it's important to specify three things:
- 
-  1. What you expected to happen
-  1. What actually happened
-  1. The 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, including the release of Ubuntu you are using and steps for someone else to recreate the bug.  It is better to have too much information in the description than not enough.
- 
- Only describe a single problem per bug report so that each can be followed up on in detail. If you experience several issues file separate reports.
- 
- Add supporting attachments to explain or help others reproduce your bug. This might include a screenshot or video capture of the problem or a sample document that triggers the fault.  To add an attachment to the bug use the '''Include an attachment''' section of the bug form.  Additional attachments, if necessary, can be added after the bug is reported via '''Add a comment/attachment''' at the bottom of the page.
- 
- For anything hardware related, give precise details about your hardware. Attaching the output of "lspci -vvnn" and "dmesg", after a fresh boot, will help a lot.
- 
- = When not to file a bug =
- 
-  * '''Requesting new software''' you should follow the guidelines in https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages
-  * '''Support requests''' should go to [[https://answers.launchpad.net/ubuntu|support requests in Launchpad]], the [[http://www.ubuntuforums.org/|Ubuntu forums]], the [[irc://irc.freenode.net/#ubuntu|#ubuntu]] channel  on the [[https://help.ubuntu.com/community/InternetRelayChat|Freenode IRC]] server, or the [[http://lists.ubuntu.com/mailman/listinfo/ubuntu-users|ubuntu-users]] mailing list.
-  * '''Feature and policy discussions''' (including suggestions to change defaults) should be discussed on the [[http://lists.ubuntu.com/mailman/listinfo/ubuntu-devel-discuss|ubuntu-devel-discuss]] mailing list.
-  * '''Development ideas''' should be posted to http://brainstorm.ubuntu.com/ or discussed on the [[http://lists.ubuntu.com/mailman/listinfo/ubuntu-devel-discuss|ubuntu-devel-discuss]] mailing list.
-  * '''Already filed''' - Please check if it has already been reported by searching through the [[https://launchpad.net/distros/ubuntu/+bugs|existing bugs]] and the release notes for your release of Ubuntu: [[http://wiki.ubuntu.com/DapperReleaseNotes|6.06 (Dapper Drake)]], [[http://www.ubuntu.com/getubuntu/releasenotes/804|8.04 (Hardy Heron)]], [[http://www.ubuntu.com/getubuntu/releasenotes/810|8.10 (Intrepid Ibex)]], [[http://www.ubuntu.com/getubuntu/releasenotes/904|9.04 (Jaunty Jackalope)]], [[http://www.ubuntu.com/getubuntu/releasenotes/910|9.10 (Karmic Koala)]],[[http://www.ubuntu.com/getubuntu/releasenotes/1004|10.04 (Lucid Lynx)]] . If you have further information about an already reported bug, add this information to the existing reported bug, instead of opening a new one.
  
  [[#Top|Back to top]]
+ 
  = Getting advice =
  
- If you need help in finding the right package or providing appropriate information ask someone on [[irc://irc.freenode.net/#ubuntu-bugs|#ubuntu-bugs]] on the [[https://help.ubuntu.com/community/InternetRelayChat|Freenode IRC]] server or on the [[https://lists.ubuntu.com/mailman/listinfo/Ubuntu-bugsquad|bugsquad mailing list]].
+ Still have doubts about the bug filing process? You can ask someone on [[irc://irc.freenode.net/#ubuntu-bugs|#ubuntu-bugs]] on the [[https://help.ubuntu.com/community/InternetRelayChat|Freenode IRC]] server or on the [[https://lists.ubuntu.com/mailman/listinfo/Ubuntu-bugsquad|bugsquad mailing list]].
  
  [[#Top|Back to top]]
+ 
  = Other languages =
  
   * [[ReportingBugs_es|Spanish]]
   * [[http://www.ubuntu.ro/documentatie/comunitate/RaportareErori | Romanian]]
  
  [[#Top|Back to top]]
+ 
  = See Also =
  
-  * [[ http://screencasts.ubuntu.com/2009/09/16/Reporting_Bugs | A screencast on using these tools ]] by Daniel Holbach
+  * [[http://screencasts.ubuntu.com/2009/09/16/Reporting_Bugs|A screencast on using these tools]] by Daniel Holbach
   * [[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html|How to Report Bugs Effectively]], by Simon Tatham
   * [[Ubuntu:DebuggingProcedures|Debugging Procedures]]
  
- [[#Top|Back to top]]
- 



More information about the Ubuntu-bugsquad mailing list