From 741dddf11ae899eec6ed710daf005551f304563b Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 13 Jun 2017 08:25:59 -0700 Subject: dev-manual, ref-manual: Reorganized Bugzilla information Fixes [YOCTO #11630] Reorganized the way the information about entering bugs using Bugzilla is arranged in the documentation set. The dev-manual now has a section that is purely procedural and steps the user through the process of logging a new bug in the Bugzilla system. The ref-manual has a conceptual section that introduces the YP implementation of Bugzilla by simply telling the user what it is and what what its purpose is. (From yocto-docs rev: 4bfba345010be7bc2866b819b9754bb06f93c91f) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-newbie.xml | 126 +++++++++++++++---------- 1 file changed, 76 insertions(+), 50 deletions(-) (limited to 'documentation/dev-manual/dev-manual-newbie.xml') diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 4b039544b9..00b8c44801 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -1323,63 +1323,88 @@ -
- Tracking Bugs +
+ Submitting a Defect Against the Yocto Project - The Yocto Project uses its own implementation of - Bugzilla to track bugs. - Implementations of Bugzilla work well for group development because they track bugs and code - changes, can be used to communicate changes and problems with developers, can be used to - submit and review patches, and can be used to manage quality assurance. - The home page for the Yocto Project implementation of Bugzilla is - &YOCTO_BUGZILLA_URL;. + Use the Yocto Project implementation of + Bugzilla + to submit a defect (bug) against the Yocto Project. + For additional information on this implementation of Bugzilla see the + "Yocto Project Bugzilla" + section in the Yocto Project Reference Manual. + For more detail on any of the following steps, see the Yocto Project + Bugzilla wiki page. - Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself - such as when discovering an issue with some component of the build system that acts contrary - to the documentation or your expectations. - Following is the general procedure for submitting a new bug using the Yocto Project - Bugzilla. - You can find more information on defect management, bug tracking, and feature request - processes all accomplished through the Yocto Project Bugzilla on the - wiki page. + Use the following general steps to submit a bug" + - Always use the Yocto Project implementation of Bugzilla to submit - a bug. - When submitting a new bug, be sure to choose the appropriate - Classification, Product, and Component for which the issue was found. - Defects for the Yocto Project fall into one of seven classifications: - Yocto Project Components, Infrastructure, Build System & Metadata, - Documentation, QA/Testing, Runtime and Hardware. - Each of these Classifications break down into multiple Products and, in some - cases, multiple Components. - Use the bug form to choose the correct Hardware and Architecture - for which the bug applies. - Indicate the Yocto Project version you were using when the issue - occurred. - Be sure to indicate the Severity of the bug. - Severity communicates how the bug impacted your work. - Select the appropriate "Documentation change" item - for the bug. - Fixing a bug may or may not affect the Yocto Project - documentation. - Provide a brief summary of the issue. - Try to limit your summary to just a line or two and be sure to capture the - essence of the issue. - Provide a detailed description of the issue. - You should provide as much detail as you can about the context, behavior, output, - and so forth that surrounds the issue. + + Open the Yocto Project implementation of + Bugzilla. + + + Click "File a Bug" to enter a new bug. + + + Choose the appropriate "Classification", "Product", and + "Component" for which the bug was found. + Bugs for the Yocto Project fall into one of several + classifications, which in turn break down into several + products and components. + For example, for a bug against the + meta-intel layer, you would choose + "Build System, Metadata & Runtime", "BSPs", and + "bsps-meta-intel", respectively. + + + Choose the "Version" of the Yocto Project for which you found + the bug (e.g. &DISTRO;). + + + Determine and select the "Severity" of the bug. + The severity indicates how the bug impacted your work. + + + Choose the "Hardware" that the bug impacts. + + + Choose the "Architecture" that the bug impacts. + + + Choose a "Documentation change" item for the bug. + Fixing a bug might or might not affect the Yocto Project + documentation. + If you are unsure of the impact to the documentation, select + "Don't Know". + + + Provide a brief "Summary" of the bug. + Try to limit your summary to just a line or two and be sure + to capture the essence of the bug. + + + Provide a detailed "Description" of the bug. + You should provide as much detail as you can about the context, + behavior, output, and so forth that surrounds the bug. You can even attach supporting files for output from logs by - using the "Add an attachment" button. - Be sure to copy the appropriate people in the - "CC List" for the bug. - See the "How to Submit a Change" - section for information about finding out who is responsible - for code. - Submit the bug by clicking the "Submit Bug" button. + using the "Add an attachment" button. + + + Click the "Submit Bug" button submit the bug. + A new Bugzilla number is assigned to the bug and the defect + is logged in the bug tracking system. + + Once you file a bug, the bug is processed by the Yocto Project Bug + Triage Team and further details concerning the bug are assigned + (e.g. priority and owner). + You are the "Submitter" of the bug and any further categorization, + progress, or comments on the bug result in Bugzilla sending you an + automated email concerning the particular change or progress to the + bug.
@@ -1551,7 +1576,8 @@ Just provide the name of the file for which you are interested. The information returned is not ordered by history but does - include a list of all committers grouped by name. + include a list of everyone who has committed grouped by + name. From the list, you can see who is responsible for the bulk of the changes against the file. -- cgit v1.2.3-54-g00ecf