summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-13 08:25:59 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-06-14 10:19:25 +0100
commit741dddf11ae899eec6ed710daf005551f304563b (patch)
tree9ed248ca23631feb9c96ba13a459204cfd89e547
parent0dae0865ba2be2322475b8877c25a45b56c79b48 (diff)
downloadpoky-741dddf11ae899eec6ed710daf005551f304563b.tar.gz
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 <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml126
-rw-r--r--documentation/ref-manual/resources.xml36
-rw-r--r--documentation/ref-manual/usingpoky.xml8
3 files changed, 114 insertions, 56 deletions
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 @@
1323 </para> 1323 </para>
1324</section> 1324</section>
1325 1325
1326<section id='tracking-bugs'> 1326<section id='submitting-a-defect-against-the-yocto-project'>
1327 <title>Tracking Bugs</title> 1327 <title>Submitting a Defect Against the Yocto Project</title>
1328 1328
1329 <para> 1329 <para>
1330 The Yocto Project uses its own implementation of 1330 Use the Yocto Project implementation of
1331 <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs. 1331 <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink>
1332 Implementations of Bugzilla work well for group development because they track bugs and code 1332 to submit a defect (bug) against the Yocto Project.
1333 changes, can be used to communicate changes and problems with developers, can be used to 1333 For additional information on this implementation of Bugzilla see the
1334 submit and review patches, and can be used to manage quality assurance. 1334 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-bugtracker'>Yocto Project Bugzilla</ulink>"
1335 The home page for the Yocto Project implementation of Bugzilla is 1335 section in the Yocto Project Reference Manual.
1336 <ulink url='&YOCTO_BUGZILLA_URL;'>&YOCTO_BUGZILLA_URL;</ulink>. 1336 For more detail on any of the following steps, see the Yocto Project
1337 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla wiki page</ulink>.
1337 </para> 1338 </para>
1338 1339
1339 <para> 1340 <para>
1340 Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself 1341 Use the following general steps to submit a bug"
1341 such as when discovering an issue with some component of the build system that acts contrary 1342
1342 to the documentation or your expectations.
1343 Following is the general procedure for submitting a new bug using the Yocto Project
1344 Bugzilla.
1345 You can find more information on defect management, bug tracking, and feature request
1346 processes all accomplished through the Yocto Project Bugzilla on the
1347 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>wiki page</ulink>.
1348 <orderedlist> 1343 <orderedlist>
1349 <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit 1344 <listitem><para>
1350 a bug.</para></listitem> 1345 Open the Yocto Project implementation of
1351 <listitem><para>When submitting a new bug, be sure to choose the appropriate 1346 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>.
1352 Classification, Product, and Component for which the issue was found. 1347 </para></listitem>
1353 Defects for the Yocto Project fall into one of seven classifications: 1348 <listitem><para>
1354 Yocto Project Components, Infrastructure, Build System &amp; Metadata, 1349 Click "File a Bug" to enter a new bug.
1355 Documentation, QA/Testing, Runtime and Hardware. 1350 </para></listitem>
1356 Each of these Classifications break down into multiple Products and, in some 1351 <listitem><para>
1357 cases, multiple Components.</para></listitem> 1352 Choose the appropriate "Classification", "Product", and
1358 <listitem><para>Use the bug form to choose the correct Hardware and Architecture 1353 "Component" for which the bug was found.
1359 for which the bug applies.</para></listitem> 1354 Bugs for the Yocto Project fall into one of several
1360 <listitem><para>Indicate the Yocto Project version you were using when the issue 1355 classifications, which in turn break down into several
1361 occurred.</para></listitem> 1356 products and components.
1362 <listitem><para>Be sure to indicate the Severity of the bug. 1357 For example, for a bug against the
1363 Severity communicates how the bug impacted your work.</para></listitem> 1358 <filename>meta-intel</filename> layer, you would choose
1364 <listitem><para>Select the appropriate "Documentation change" item 1359 "Build System, Metadata &amp; Runtime", "BSPs", and
1365 for the bug. 1360 "bsps-meta-intel", respectively.
1366 Fixing a bug may or may not affect the Yocto Project 1361 </para></listitem>
1367 documentation.</para></listitem> 1362 <listitem><para>
1368 <listitem><para>Provide a brief summary of the issue. 1363 Choose the "Version" of the Yocto Project for which you found
1369 Try to limit your summary to just a line or two and be sure to capture the 1364 the bug (e.g. &DISTRO;).
1370 essence of the issue.</para></listitem> 1365 </para></listitem>
1371 <listitem><para>Provide a detailed description of the issue. 1366 <listitem><para>
1372 You should provide as much detail as you can about the context, behavior, output, 1367 Determine and select the "Severity" of the bug.
1373 and so forth that surrounds the issue. 1368 The severity indicates how the bug impacted your work.
1369 </para></listitem>
1370 <listitem><para>
1371 Choose the "Hardware" that the bug impacts.
1372 </para></listitem>
1373 <listitem><para>
1374 Choose the "Architecture" that the bug impacts.
1375 </para></listitem>
1376 <listitem><para>
1377 Choose a "Documentation change" item for the bug.
1378 Fixing a bug might or might not affect the Yocto Project
1379 documentation.
1380 If you are unsure of the impact to the documentation, select
1381 "Don't Know".
1382 </para></listitem>
1383 <listitem><para>
1384 Provide a brief "Summary" of the bug.
1385 Try to limit your summary to just a line or two and be sure
1386 to capture the essence of the bug.
1387 </para></listitem>
1388 <listitem><para>
1389 Provide a detailed "Description" of the bug.
1390 You should provide as much detail as you can about the context,
1391 behavior, output, and so forth that surrounds the bug.
1374 You can even attach supporting files for output from logs by 1392 You can even attach supporting files for output from logs by
1375 using the "Add an attachment" button.</para></listitem> 1393 using the "Add an attachment" button.
1376 <listitem><para>Be sure to copy the appropriate people in the 1394 </para></listitem>
1377 "CC List" for the bug. 1395 <listitem><para>
1378 See the "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" 1396 Click the "Submit Bug" button submit the bug.
1379 section for information about finding out who is responsible 1397 A new Bugzilla number is assigned to the bug and the defect
1380 for code.</para></listitem> 1398 is logged in the bug tracking system.
1381 <listitem><para>Submit the bug by clicking the "Submit Bug" button.</para></listitem> 1399 </para></listitem>
1382 </orderedlist> 1400 </orderedlist>
1401 Once you file a bug, the bug is processed by the Yocto Project Bug
1402 Triage Team and further details concerning the bug are assigned
1403 (e.g. priority and owner).
1404 You are the "Submitter" of the bug and any further categorization,
1405 progress, or comments on the bug result in Bugzilla sending you an
1406 automated email concerning the particular change or progress to the
1407 bug.
1383 </para> 1408 </para>
1384</section> 1409</section>
1385 1410
@@ -1551,7 +1576,8 @@
1551 </literallayout> 1576 </literallayout>
1552 Just provide the name of the file for which you are interested. 1577 Just provide the name of the file for which you are interested.
1553 The information returned is not ordered by history but does 1578 The information returned is not ordered by history but does
1554 include a list of all committers grouped by name. 1579 include a list of everyone who has committed grouped by
1580 name.
1555 From the list, you can see who is responsible for the bulk of 1581 From the list, you can see who is responsible for the bulk of
1556 the changes against the file. 1582 the changes against the file.
1557 </para></listitem> 1583 </para></listitem>
diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml
index 8299f9f3ca..0cd0e5a254 100644
--- a/documentation/ref-manual/resources.xml
+++ b/documentation/ref-manual/resources.xml
@@ -17,11 +17,41 @@
17</section> 17</section>
18 18
19<section id='resources-bugtracker'> 19<section id='resources-bugtracker'>
20 <title>Tracking Bugs</title> 20 <title>Yocto Project Bugzilla</title>
21 21
22 <para> 22 <para>
23 If you find problems with the Yocto Project, you should report them using the 23 The Yocto Project uses its own implementation of
24 Bugzilla application at <ulink url='&YOCTO_BUGZILLA_URL;'></ulink>. 24 <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track
25 defects (bugs).
26 Implementations of Bugzilla work well for group development because
27 they track bugs and code changes, can be used to communicate changes
28 and problems with developers, can be used to submit and review patches,
29 and can be used to manage quality assurance.
30 </para>
31
32 <para>
33 Sometimes it is helpful to submit, investigate, or track a bug against
34 the Yocto Project itself (e.g. when discovering an issue with some
35 component of the build system that acts contrary to the documentation
36 or your expectations).
37 </para>
38
39 <para>
40 A general procedure and guidelines exist for when you use Bugzilla to
41 submit a bug.
42 For information on how to use Bugzilla to submit a bug against the
43 Yocto Project, see the following:
44 <itemizedlist>
45 <listitem><para>
46 The
47 "<ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project'>Submitting a Defect Against the Yocto Project</ulink>"
48 section in the Yocto Project Development Manual.
49 </para></listitem>
50 <listitem><para>
51 The Yocto Project
52 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla wiki page</ulink>
53 </para></listitem>
54 </itemizedlist>
25 </para> 55 </para>
26</section> 56</section>
27 57
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index d08031617b..4e97e3ec02 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -1031,9 +1031,11 @@
1031 the Yocto Project implementation of 1031 the Yocto Project implementation of
1032 <ulink url='https://bugzilla.yoctoproject.org/'>Bugzilla</ulink>. 1032 <ulink url='https://bugzilla.yoctoproject.org/'>Bugzilla</ulink>.
1033 For general information on how to submit a bug against 1033 For general information on how to submit a bug against
1034 the Yocto Project, see the 1034 the Yocto Project, see the Yocto Project Bugzilla
1035 "<ulink url='&YOCTO_DOCS_DEV_URL;#tracking-bugs'>Tracking Bugs</ulink>" 1035 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>wiki page</ulink>"
1036 section in the Yocto Project Development Manual. 1036 or the
1037 <ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project'>Submitting a Defect Against the Yocto Project</ulink>"
1038 section, which is in the Yocto Project Development Manual.
1037 <note> 1039 <note>
1038 The manuals might not be the right place to document 1040 The manuals might not be the right place to document
1039 variables that are purely internal and have a limited 1041 variables that are purely internal and have a limited