summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml75
1 files changed, 45 insertions, 30 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index c85667cdd1..08b4747480 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -542,44 +542,59 @@
542 <title>Tracking Bugs</title> 542 <title>Tracking Bugs</title>
543 543
544 <para> 544 <para>
545 The Yocto Project uses <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs. 545 The Yocto Project uses its own implementation of
546 This bug-tracking application works well for group development because it tracks bugs and code 546 <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs.
547 Implementations of Bugzilla work well for group development because they track bugs and code
547 changes, can be used to communicate changes and problems with developers, can be used to 548 changes, can be used to communicate changes and problems with developers, can be used to
548 submit and review patches, and can be used to manage quality assurance. 549 submit and review patches, and can be used to manage quality assurance.
549 You can find a good overview of Bugzilla <ulink url='http://www.bugzilla.org/about/'>here</ulink>. 550 The home page for the Yocto Project implementation of Bugzilla is
551 <ulink url='http://bugzilla.yoctoproject.org'>http://bugzilla.yoctoproject.org</ulink>.
550 </para> 552 </para>
551 553
552 <para> 554 <para>
553 Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself 555 Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself
554 such as when discovering an issue with some component of the build system that acts contrary 556 such as when discovering an issue with some component of the build system that acts contrary
555 to the documentation or your expectations. 557 to the documentation or your expectations.
556 You can find information 558 Following is the general procedure for submitting a new bug using the Yocto Project
557 for Bugzilla configuration and bug tracking procedures specific to the Yocto Project 559 Bugzilla.
560 You can find more information on defect management, bug tracking, and feature request
561 processes all accomplished through the Yocto Project Bugzilla on the wiki page
558 <ulink url='https://wiki.yoctoproject.org/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>. 562 <ulink url='https://wiki.yoctoproject.org/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>.
559 </para> 563 <orderedlist>
560 564 <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit
561 <para> 565 a bug.</para></listitem>
562 The Yocto Project uses its own version of the Bugzilla application. 566 <listitem><para>When submitting a new bug, be sure to choose the appropriate
563 You can find the home page <ulink url='http://bugzilla.yoctoproject.org'>here</ulink>. 567 Classification, Product, and Component for which the issue was found.
564 You need to use this implementation of Bugzilla when logging a defect against anything released 568 Defects for Yocto Project fall into one of four classifications: Yocto Projects,
565 by the Yocto Project team. 569 Infrastructure, Poky, and Yocto Metadata Layers.
566 </para> 570 Each of these Classifications break down into multiple Products and, in some
567 571 cases, multiple Components.</para></listitem>
568 <para> 572 <listitem><para>Use the bug form to choose the correct Hardware and Architecture
569 Here are some things to remember when dealing with bugs against the Yocto Project: 573 for which the bug applies.</para></listitem>
570 <itemizedlist> 574 <listitem><para>Indicate the Yocto Project version you were using when the issue
571 <listitem><para>The Yocto Project follows a bug-naming convention: 575 occurred.</para></listitem>
572 <filename>[YOCTO #&lt;number&gt;]</filename>, where <filename>&lt;number&gt;</filename> is the 576 <listitem><para>Be sure to indicate the Severity of the bug.
573 assigned defect ID used in Bugzilla. 577 Severity communicates how the bug impacted your work.</para></listitem>
574 So, for example, a valid way to refer to a defect when creating a commit comment 578 <listitem><para>Provide a brief summary of the issue.
575 would be <filename>[YOCTO #1011]</filename>. 579 Try to limit your summary to just a line or two and be sure to capture the
576 This convention becomes important if you are submitting patches against the Yocto Project 580 essence of the issue.</para></listitem>
577 code itself. 581 <listitem><para>Provide a detailed description of the issue.
578 See the following section for more information.</para></listitem> 582 You should provide as much detail as you can about the context, behavior, output,
579 <listitem><para>Defects for Yocto Project fall into one of four classifications: Yocto Projects, 583 and so forth that surround the issue.
580 Infrastructure, Poky, and Yocto Metadata Layers.</para></listitem> 584 You can even attach supporting files for output or log by using the "Add an attachment"
581 </itemizedlist> 585 button.</para></listitem>
582 </para> 586 <listitem><para>Submit the bug by clicking the "Submit Bug" button.</para></listitem>
587 </orderedlist>
588 </para>
589
590 <note>
591 Bugs in the Yocto Project Bugzilla follow naming convention:
592 <filename>[YOCTO #&lt;number&gt;]</filename>, where <filename>&lt;number&gt;</filename> is the
593 assigned defect ID used in Bugzilla.
594 So, for example, a valid way to refer to a defect would be <filename>[YOCTO #1011]</filename>.
595 This convention becomes important if you are submitting patches against the Yocto Project
596 code itself.
597 </note>
583</section> 598</section>
584 599
585<section id='how-to-submit-a-change'> 600<section id='how-to-submit-a-change'>