Bugzilla/Bug report guide

This article should address many things you should keep in mind to make other people's life easier, when filing a bug report. Always remember, that they care about your problems for free.

Best practice

 * Reread the text before submission, the changes are not reversible and the text cannot be edited afterwards. Also any text entered into a bug report will be usually e-mailed immediately to a lot of people. Write in precise and clean language.


 * Search for duplicates, before creating a new bug.


 * Stay on topic - A bug ticket is used for technical reports and chitchat should be avoided. Keep them in the support channels (forums, IRC or mailing-lists).
 * Confirm the existence of a problem only once. - It does not help solving the problem, if you and another person report it twice. But if your and the confirmer's systems differ in an obvious way and that would be helpful to know, add this information.
 * Open one bug ticket per topic - If your problem is not discussed on a bug, search for one related to your issue or create a new report. Do not hijack bugs.
 * No talk on TRACKER bugs. - Those bugs are meta bugs. If you want to add useful information, add them to a related sub bug or create a new bug.

Packages/ebuild
You should always add information about your system configuration to the bug. To do so, create a new attachment and paste the contents of:

Problems at build time
Files and information of interest ordered by priority:


 * The exact version of the package in the title of the bug report e.g. sys-apps/package-2.3-r4
 * If possible, add parts of the error message to the title
 * The logfile in
 * If your logfile is too big to upload, compress it: and upload build.log.xz from this directory
 * The output of emerge --info 

Problems at run time
Files and information of interest ordered by priority:


 * The exact version of the package in the title of the bug report e.g. sys-apps/package-2.3-r4 crashes with error: Cannot proceed...
 * Description of the problem, so that other can reproduce it:
 * How is the program run (on the console, in a terminal, as a daemon, in what runlevel etc.)
 * Any error output
 * What makes the program crash, behave wrong, not start
 * Is there a workaround?
 * What was the last working version of the package, if any?
 * What changed to make it not work?
 * Attach the output of emerge --info
 * Attach the output of emerge -pv  to quickly see what are the dependencies

Bump requests; a newer upstream release is available since a while

 * 1) Search Bugzilla before posting a bump request - is there already a bug open? Has the local Portage tree been synced lately; is it already in Portage?
 * 2) Has it actually been released by upstream sources, or is it just marked in the source tree? Some projects mark a release in the tree long time before it is officially released.
 * 3) Be sure to mention if it compiles and runs well on your arch. Any other helpful information you provide is most welcome.
 * 4) Have dependencies changed?

Upstream's website indicates that a new release is available:


 * Avoid Zero-day bump requests (wait at least 48 hours after the release announcement)
 * Link to the upstream website in the bug report
 * Give a link or list of fixed bugs or new features (sometimes called changelog)

If providing new information for the upgraded ebuild (optional):


 * If the new version needs no changes to the ebuild's contents, please indicate such
 * Test the ebuild in a local overlay before submitting attachments
 * Provide patches for proposed ebuild edits, with optional explanation of changes (file name should match the new version number, not old)
 * Provide additional files (initd, unit files) as separate attachments (as needed)
 * Do not paste ebuilds or other ebuild-related file contents directly into comments; use attachments for those

Package XY should be in Portage
If you request a new ebuild for a software to be added to portage, you must find or become a maintainer for the package:


 * Link to the upstream website in the bug report
 * Give a link or list of features
 * Provide an ebuild and patches that were tested in the local overlay (you can get help in IRC or in the forums with that)

Package XY should be marked stable
A package is building and working without problems on the system for more than 30 days but is still marked as unstable:


 * See KEYWORDS for more information on stable/unstable branch
 * Did you test the version you want to become stable thoroughly?
 * Are there other bug reports regarding this bug?
 * Was the version of the package added to the tree at least 30 days ago?
 * Are its dependencies all marked stable?

Kernel
Files and information of interest for kernel bug reports ordered by priority:


 * Which kernel and version is used, on what architecture e.g. gentoo-sources-3.4.2-r2 on x86_64
 * The kernel configuration file should be attached to the bug report
 * A list of all devices in the system can be acquired with lspci -k
 * Log files during kernel initialization should be attached or

Other bug reports
There is no real template, this falls under the category like problems with captcha on wiki.gentoo.org, forum.gentoo.org is down or anything else that is not really related to software.

External resources

 * Gentoo's Bugzilla site