Bug reporting and Information levels: Difference between revisions

From Yocto Project
Jump to navigationJump to search
No edit summary
Line 10: Line 10:


*Before reporting a bug, please read the [https://bugzilla.yoctoproject.org/page.cgi?id=bug-writing.html bug writing guidelines], please look at the list of [https://bugzilla.yoctoproject.org/duplicates.cgi most frequently reported bugs], and please [https://bugzilla.yoctoproject.org/query.cgi search] for the bug.
*Before reporting a bug, please read the [https://bugzilla.yoctoproject.org/page.cgi?id=bug-writing.html bug writing guidelines], please look at the list of [https://bugzilla.yoctoproject.org/duplicates.cgi most frequently reported bugs], and please [https://bugzilla.yoctoproject.org/query.cgi search] for the bug.
*Be precise
*Be precise and clear - explain it so others can reproduce the bug
*Be clear - explain it so others can reproduce the bug
*One bug per report
*One bug per report
*No bug is too trivial to report - small bugs may hide big bugs
*No bug is too trivial to report - small bugs may hide big bugs
Line 17: Line 16:
*Provide clear and simple bug subject. It is recommended to put a Fault Component Name with brackets at the beginning of subject as a keyword, e.g. [Poky].  
*Provide clear and simple bug subject. It is recommended to put a Fault Component Name with brackets at the beginning of subject as a keyword, e.g. [Poky].  
*Validate all fields are correct. If fields are not filled out correctly, the bug might be sent back to the submitter.
*Validate all fields are correct. If fields are not filled out correctly, the bug might be sent back to the submitter.
*Judge the right Severity.
*Adds any additional information from the bug scrub.
*Adds any additional information from the bug scrub.
*Assigns the bug to the correct person to disposition the bug.
*Assigns the bug to the correct person to disposition the bug.
*If a bug is too vague to make a determination then the Resolution Field of the bug will be set to need more information and sent back the bug submitter.
*If a bug is too vague to make a determination then the Resolution Field of the bug will be set to need more information and sent back the bug submitter.
*Judge the right Severity.
*Bug Priority can't be set when report a bug. It will be set when doing bug Triage meeting
*Bug Priority can't be set when report a bug. It will be set when doing bug Triage meeting


= Preliminaries=
= Preliminaries=

Revision as of 10:14, 17 October 2014

You should also read our Community Guidelines before submitting bugs.


Bug submission steps

Create an bugzilla account

Bug Reporter guidelines

  • Before reporting a bug, please read the bug writing guidelines, please look at the list of most frequently reported bugs, and please search for the bug.
  • Be precise and clear - explain it so others can reproduce the bug
  • One bug per report
  • No bug is too trivial to report - small bugs may hide big bugs
  • Clearly separate fact from speculation
  • Provide clear and simple bug subject. It is recommended to put a Fault Component Name with brackets at the beginning of subject as a keyword, e.g. [Poky].
  • Validate all fields are correct. If fields are not filled out correctly, the bug might be sent back to the submitter.
  • Adds any additional information from the bug scrub.
  • Assigns the bug to the correct person to disposition the bug.
  • If a bug is too vague to make a determination then the Resolution Field of the bug will be set to need more information and sent back the bug submitter.
  • Judge the right Severity.
  • Bug Priority can't be set when report a bug. It will be set when doing bug Triage meeting

Preliminaries

  • Reproduce your bug using a recent build of the software, to see whether it has already been fixed.
  • Search Bugzilla, to see whether your bug has already been reported.

Reporting a New Bug - example 1

If you have reproduced the bug in a recent build and no-one else appears to have reported it, then:

  1. Choose "Enter a new bug"
  2. Select the product in which you've found the bug
  3. Fill out the form. Here is some help understanding it:
Component: In which sub-part of the software does it exist?
This field is required. Click the word "Component" to see a description of each component. If none seems appropriate, look for a "General" component.
OS: On which operating system (OS) did you find it? (e.g. Linux, Windows XP, Mac OS X.)
If you know the bug happens on more than one type of operating system, choose All. If your OS isn't listed, choose Other.
Summary: How would you describe the bug, in approximately 60 or fewer characters?
A good summary should quickly and uniquely identify a bug report. It should explain the problem, not your suggested solution.
  • Good: "Cancelling a File Copy dialog crashes File Manager"
  • Bad: "Software crashes"
  • Bad: "Browser should work with my web site"
Description: The details of your problem report, including:
Build Date & Platform: Date and platform of the build in which you first encountered the bug.
Additional Builds and Platforms: Whether or not the bug takes place on other platforms (or browsers, if applicable).
  • Doesn't Occur On Build 2006-08-10 on Windows XP Home (Service Pack 2), or name the commit
Overview: More detailed restatement of summary.
  • Drag-selecting any page crashes Mac builds in the NSGetFactory function.
Steps to Reproduce: Minimized, easy-to-follow steps that will trigger the bug. Include any special setup steps.
  1. View any web page. (I used the default sample page, resource:/res/samples/test0.html)
  2. Drag-select the page. (Specifically, while holding down the mouse button, drag the mouse pointer downwards from any point in the browser's content region to the bottom of the browser's content region.)
Actual Result: What the application did after performing the above steps.
  • The application crashed.
Expected Results: What the application should have done, were the bug not present.
  • The window should scroll downwards. Scrolled content should be selected. (Or, at least, the application should not crash.)
Additional Information: Any other useful information.
For crashing bugs:
  • Windows: Note the type of the crash, and the module that the application crashed in (e.g. access violation in apprunner.exe).
  • Mac OS X: Attach the "Crash Reporter" log that appears upon crash. Only include the section directly below the crashing thread, usually titled "Thread 0 Crashed". Please do not paste the entire log!
For errors reported on the Error reports website:

Double-check your report for errors and omissions, then press "Commit". Your bug report will now be in the Bugzilla database.

Reporting a New Bug - example 2

If it's more related to a build on your machine (e.g. you didn't test using the build artefacts from the autobuilder), also the build configuration can be stated in the Build Date and Platform section":

Build Configuration: 
BB_VERSION        = "1.24.0"
BUILD_SYS         = "x86_64-linux"
NATIVELSBSTRING   = "Fedora-19"
TARGET_SYS        = "x86_64-poky-linux"
MACHINE           = "qemux86-64"
DISTRO            = "poky"
DISTRO_VERSION    = "1.7"
TUNE_FEATURES     = "m64 core2"
TARGET_FPU        = ""
meta
meta-yocto
meta-yocto-bsp    = "master:abcb18a362e4fcb7612b43eb1e4e09f89ea02ea8"