Bug reporting etiquette

感謝您閱讀本文章，This will guide you on how best to present your bug report so that it gets addressed as soon as possible. Here are a few guiding principles that lead to success in getting bugs fixed:

在Launchpad上回報任何與硬體有關的Bug時，請先將您的BIOS，以及週邊硬體（CF卡讀卡機，SSD，USB 3.0 控制器，DVD/CD光碟機等等）的韌體更新至the newest available from your vendor. Outdated and buggy BIOS and firmware is a common cause of a variety of hardware issues (ex. intermittent wireless, suspend not working, certain keys on keyboard not working correctly, card readers not working, and kernel panics after plugging USB drive in). If your vendor has a newer version of the BIOS on their website, and you have not updated to this, your report is considered Status Incomplete whether or not someone toggled the Status of your report.

Please do not quote Wikipedia and other non-primary resource information as fact on Launchpad.

Many Linux package, hardware, and other non-user space bugs are hardware dependent on both the hardware itself, and what other hardware the problematic hardware is connected to. The rule of thumb is one report, per person, per hardware combination, per bug. For more on this please see here, and further below in this article. As well, please do not post comments to another person's report, claiming you have the same problem, because you have the same hardware, or same computer model. Instead, please file a separate report, and make comments there. This is because no one can verify if you would have the same problem or not, because your hardware can not be analyzed.

For bugs in the Linux (Ubuntu) package, unless the upstream maintainer or kernel developer notes otherwise, if a new mainline kernel comes out, and you haven't tested with it, your report is considered Status Incomplete whether or not someone toggled the Status of your report.

Please do not solicit non-original reporters to post comments, attachments, etc.

Please do not post comments such as “Me too!”, “+1”, “bump”, “same here”, etc., as it is largely unhelpful, produces spammy e-mail traffic to everyone subscribed to the report, and quite often turns out not to be the same root cause. Instead, please follow the below mentioned procedures.

Please do not stack multiple issues into one report. For example, jamming suspend and hibernate into one report, reporting multiple hotkey problems into one report (ex. Fn+F3 doesn't turn off my laptop WiFi, Fn+Right doesn't turn the brightness on my backlight down, my brightness settings are not remembered after reboot, etc.). Please make one report for each individual problem.

Please do not complain about how long it takes to fix a bug, the severity of your bug is high so it should be fixed immediately, “I cannot believe it’s not fixed…”, XYZ person(s) do not care about fixing bugs, etc. Especially, if you have not followed the directions mentioned in this article, let alone contributed code upstream. This type of behavior is unconstructive, irritating to others who read your e-mail, and spammy. We all want to see every bug fixed as soon as possible! Naturally, bugs being fixed is limited to reproducibility and clarity of the bug report, the actual impact the bug has on the community, and available developer resources.

Please keep the bug objective as possible. It is desired for you to provide a fact based, technical impact statement on you, your environment, and the potential or actual impact on the community at large.

Please provide all relevant information from https://wiki.ubuntu.com/DebuggingProcedures when you first report your bug. This is one of the top reasons why bugs do not get marked Triaged, as the minimum requirements for dealing with the problem by a developer are not provided.

If a triager or developer asks you to provide information, please avoid arguing with them. Just provide the information as requested. If you have a strong disagreement with what a triager or developer is asking of you, please resolve it with them via personal message, instead of turning a bug development report into a “let’s talk about talking about the problem” report. The Ubuntu community takes a favor to objective, technical discourse.

Many of the triagers and developers who are providing support to you, are volunteers doing so out of altruism. Please keep this in mind when making your comments.

Please do not report bugs about software in PPAs on Launchpad. This is because software in PPAs are not provided by the official Ubuntu repositories. Instead, the PPA homepage would have a contact point and preference of the PPA provider.

Please do not add project tasks to bug reports that are invalid because they are not supported. For example, if you were using the LibreOffice PPA and reported a bug against the package libreoffice (Ubuntu), which would be marked Status Invalid, please do not add the Launchpad Project df-libreoffice to the report, or change the package libreoffice (Ubuntu) to the project df-libreoffice. The purposes of adding the upstream project to a report is to track valid bugs in Ubuntu that are valid upstream, and may have been reported upstream, not to start another upstream bug tracker.

如何回報Bug

Ubuntu使用Launchpad來作Bug及其修復情況的追蹤。This page will guide you through the steps required to file a good and detailed report.

建立您的Launchpad帳號

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.

Determine if the bug is really a bug

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 help using Ubuntu, such as the Launchpad answer tracker, the Ask Ubuntu site, the Ubuntu forums, the #ubuntu channel on the Freenode IRC server, and the ubuntu-users mailing list.

• Discussing features and existing policy: this belongs to the ubuntu-devel-discuss mailing list.

• Proposing features and ideas: you should submit your idea to Ubuntu Brainstorm or to the 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 here.

確定該Bug尚未被回報過

First, check the release notes for your version of Ubuntu:

• Ubuntu 10.04 LTS (Lucid Lynx)

• Ubuntu 12.04 LTS (Precise Pangolin)

• Ubuntu 12.10 (Quantal Quetzal)

• Ubuntu 13.04 (Raring Ringtail)

硬體驅動程式相關的Bug（如sound, Linux kernel, X.Org, and Nvidia / AMD proprietary drivers）

• For hardware driver bugs you are welcome to check for duplicates. However, depending on if you are the original reporter or not, determines what to do next. The following is a list of hardware packages:

  • For sound bugs please see https://wiki.ubuntu.com/DebuggingSoundProblems.

  • Linux kernel (e.g. suspend, hibernate, and other potential kernel issues).

  • xorg and xorg-server

  • xserver-xorg-input-synaptics (e.g. certain Touchpad issues).

  • xserver-xorg-video-intel and other xserver-xorg-video-* like nouveau, radeon, ati, openchrome, geode, etc.

  • Nvidia proprietary driver software: nvidia-graphics-drivers , graphics-drivers-173 , nvidia-settings , and nvidia-graphics-drivers-180 .

  • AMD proprietary drivers: fglrx-installer and fglrx-installer-updates.

You are not the original reporter

• Please open a new report instead of adding debugging information, attachments, apport-collect’ing, or “Me too!” comments on what may appear to be a similar bug. Chances are that your hardware does not match the existing bug’s hardware, so your bug and comments will not be addressed. As well, unless asked of you by a developer or triager, please do not mark your bug a duplicate of another reporter's bug.

• Please do not assume because you have the same desktop or laptop model line as another original reporter’s bug report, that your problem is the same. Frequently, computer vendors use different parts under the hood within the same model line.
• Regarding peripherals, please do not assume because you have the same peripheral, and similar problems, it is the same bug. Please file a new bug report.

You are the original reporter

If you are the original reporter, here are the ways to maximize the speed with which your bug is fixed:

• Check for the problem in the earliest release that works for your hardware and the latest. Report your testing results in the report.

• Test for this problem in the mainline kernel following https://wiki.ubuntu.com/Kernel/MainlineBuilds. Report your mainline testing results in the report.

• If your bug is a regression, bisect it following https://wiki.ubuntu.com/Kernel/KernelBisection. Report your bisect results in the report.

桌面應用程式

For desktop applications, please make sure it has not already been reported by searching through existing bugs. If you find an already reported bug that is exactly like the problem you have, please feel free to add this information to the existing report, rather than opening a new one. However, if you have any doubt as to it being the same or not, please file a separate report.

回到頁首

Reporting a Bug

Reporting an application crash

Please report an application crash via the methods outlined below and at https://wiki.ubuntu.com/DebuggingProgramCrash.

Development release

If an application crashes, and you're using a development release, Apport will start automatically, raising an appropriate bug report for you to complete in Launchpad. This report is subsequently processed by Apport Retracing Service, in order to provide developers with debugging information that make it easier to fix the problem.

Stable release

Apport may come disabled by default. To enable it, edit the file:

/etc/default/apport

and change:

enabled=0

to:

enabled=1

Even when enabled, apport will not upload crash reports to Launchpad for a stable release (see bug #994921). Instead, crash reports are uploaded to http://errors.ubuntu.com. To file a report on Launchpad anyway, one may open the following file via a command line:

gksudo gedit /etc/apport/crashdb.conf

and change:

'problem_types': ['Bug', 'Package'],

to:

# 'problem_types': ['Bug', 'Package'],

Save, close, and try to file the crash report again via:

ubuntu-bug /var/crash/_my_crash_report.crash

(NOTE: this not appear to work on Ubuntu 12.04.2 - once started, ubuntu-bug will state "The application X has closed unexpectedly. [Show details] [Leave Closed] [Relaunch]". There is no option to upload the crash report. Instead do 'apport-cli /var/crash/_my_crash_report.crash' which does seem to work.)

apport will appear to upload a crash report, but only actually does so if whoopsie is installed. Whoopsie is installed by default for users of ubuntu-desktop, but for users of alternative desktops, or for server users, whoopsie has to be installed manually with apt-get install whoopsie. See bug #1001630 for details.

System crash

• This bug is a security vulnerability: Please check this only if your bug report describes a behaviour that could be exploited to compromise your security or safety, as well as cause issues such as identity theft or "hi-jacking".

• 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. If necessary, additional attachments can be added after the bug is reported via Add a comment/attachment at the bottom of the page. Please check https://wiki.ubuntu.com/DebuggingProcedures for anything further information to provide. It is vital for developers to get this information, as it contains the minimum requirement information necessary for a developer to begin working on your bug.

  • Please note that if one files a bug against the linux kernel package, you do not need to add as an attachment the terminal command:

lspci -vvnn
lspci -vnvn

• 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.

When the file is ready, copy it to the system you intend to use for filing the report. There you can then file the report:

• ubuntu-bug -c <apport_file.extension>

'ubuntu-bug -c x.crash' does not work for crash reports from stable Ubuntu releases (see note about stable releases above).

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. Please do not attach the .apport or .crash file to the report, as this is not the same as performing the above mentioned steps.

在Launchpad.net上回報bug

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.

Crashes

First, please do not run apport-collect more than once per release tested. For example, if you originally reported a bug about Precise via Apport, and then could reproduce it in Quantal, only run apport-collect once in Quantal. This minimizes unnecessary E-Mail traffic to those subscribed to your report and keeps the report efficient. If your problem is in the linux package, and 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. As well, your attachments are subject to deletion at the discretion of developers and triagers. Instead, please open a new report via ubuntu-bug. Otherwise, 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

ERROR: The launchpadlib Python module is not installed. This functionality
is not available.

sudo apt-get -y install python-launchpadlib

Package libreoffice not installed and no hook available, ignoring

sudo apt-get -y install libreoffice

ubuntu-bug linux

ubuntu-bug my_crash_report.crash