diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-11-23 10:50:48 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-11-25 15:24:19 +0000 |
commit | 31c4229d3c0452697c7277f61c77294ffb6d6ebb (patch) | |
tree | 377ed151a1e35d75858c321287ab8712a6974479 /documentation | |
parent | ac174aaeba7bd5db2f877650d0e969ac49265ac3 (diff) | |
download | poky-31c4229d3c0452697c7277f61c77294ffb6d6ebb.tar.gz |
documentation/dev-manual/dev-manual-newbie.xml: Updates to Bugzilla use
I updated the Bug Tracking section to include rudimentary use of
Bugzilla for entering a new bug.
Fixes [YOCTO #237]
(From yocto-docs rev: 8f2702444812c9dc25195340acebbaae15cd59d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 75 |
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 0efcbbb9b0..1422384e48 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -545,44 +545,59 @@ | |||
545 | <title>Tracking Bugs</title> | 545 | <title>Tracking Bugs</title> |
546 | 546 | ||
547 | <para> | 547 | <para> |
548 | The Yocto Project uses <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs. | 548 | The Yocto Project uses its own implementation of |
549 | This bug-tracking application works well for group development because it tracks bugs and code | 549 | <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs. |
550 | Implementations of Bugzilla work well for group development because they track bugs and code | ||
550 | changes, can be used to communicate changes and problems with developers, can be used to | 551 | changes, can be used to communicate changes and problems with developers, can be used to |
551 | submit and review patches, and can be used to manage quality assurance. | 552 | submit and review patches, and can be used to manage quality assurance. |
552 | You can find a good overview of Bugzilla <ulink url='http://www.bugzilla.org/about/'>here</ulink>. | 553 | The home page for the Yocto Project implementation of Bugzilla is |
554 | <ulink url='http://bugzilla.yoctoproject.org'>http://bugzilla.yoctoproject.org</ulink>. | ||
553 | </para> | 555 | </para> |
554 | 556 | ||
555 | <para> | 557 | <para> |
556 | Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself | 558 | Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself |
557 | such as when discovering an issue with some component of the build system that acts contrary | 559 | such as when discovering an issue with some component of the build system that acts contrary |
558 | to the documentation or your expectations. | 560 | to the documentation or your expectations. |
559 | You can find information | 561 | Following is the general procedure for submitting a new bug using the Yocto Project |
560 | for Bugzilla configuration and bug tracking procedures specific to the Yocto Project | 562 | Bugzilla. |
563 | You can find more information on defect management, bug tracking, and feature request | ||
564 | processes all accomplished through the Yocto Project Bugzilla on the wiki page | ||
561 | <ulink url='https://wiki.yoctoproject.org/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>. | 565 | <ulink url='https://wiki.yoctoproject.org/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>. |
562 | </para> | 566 | <orderedlist> |
563 | 567 | <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit | |
564 | <para> | 568 | a bug.</para></listitem> |
565 | The Yocto Project uses its own version of the Bugzilla application. | 569 | <listitem><para>When submitting a new bug, be sure to choose the appropriate |
566 | You can find the home page <ulink url='http://bugzilla.yoctoproject.org'>here</ulink>. | 570 | Classification, Product, and Component for which the issue was found. |
567 | You need to use this implementation of Bugzilla when logging a defect against anything released | 571 | Defects for Yocto Project fall into one of four classifications: Yocto Projects, |
568 | by the Yocto Project team. | 572 | Infrastructure, Poky, and Yocto Metadata Layers. |
569 | </para> | 573 | Each of these Classifications break down into multiple Products and, in some |
570 | 574 | cases, multiple Components.</para></listitem> | |
571 | <para> | 575 | <listitem><para>Use the bug form to choose the correct Hardware and Architecture |
572 | Here are some things to remember when dealing with bugs against the Yocto Project: | 576 | for which the bug applies.</para></listitem> |
573 | <itemizedlist> | 577 | <listitem><para>Indicate the Yocto Project version you were using when the issue |
574 | <listitem><para>The Yocto Project follows a bug-naming convention: | 578 | occurred.</para></listitem> |
575 | <filename>[YOCTO #<number>]</filename>, where <filename><number></filename> is the | 579 | <listitem><para>Be sure to indicate the Severity of the bug. |
576 | assigned defect ID used in Bugzilla. | 580 | Severity communicates how the bug impacted your work.</para></listitem> |
577 | So, for example, a valid way to refer to a defect when creating a commit comment | 581 | <listitem><para>Provide a brief summary of the issue. |
578 | would be <filename>[YOCTO #1011]</filename>. | 582 | Try to limit your summary to just a line or two and be sure to capture the |
579 | This convention becomes important if you are submitting patches against the Yocto Project | 583 | essence of the issue.</para></listitem> |
580 | code itself. | 584 | <listitem><para>Provide a detailed description of the issue. |
581 | See the following section for more information.</para></listitem> | 585 | You should provide as much detail as you can about the context, behavior, output, |
582 | <listitem><para>Defects for Yocto Project fall into one of four classifications: Yocto Projects, | 586 | and so forth that surround the issue. |
583 | Infrastructure, Poky, and Yocto Metadata Layers.</para></listitem> | 587 | You can even attach supporting files for output or log by using the "Add an attachment" |
584 | </itemizedlist> | 588 | button.</para></listitem> |
585 | </para> | 589 | <listitem><para>Submit the bug by clicking the "Submit Bug" button.</para></listitem> |
590 | </orderedlist> | ||
591 | </para> | ||
592 | |||
593 | <note> | ||
594 | Bugs in the Yocto Project Bugzilla follow naming convention: | ||
595 | <filename>[YOCTO #<number>]</filename>, where <filename><number></filename> is the | ||
596 | assigned defect ID used in Bugzilla. | ||
597 | So, for example, a valid way to refer to a defect would be <filename>[YOCTO #1011]</filename>. | ||
598 | This convention becomes important if you are submitting patches against the Yocto Project | ||
599 | code itself. | ||
600 | </note> | ||
586 | </section> | 601 | </section> |
587 | 602 | ||
588 | <section id='how-to-submit-a-change'> | 603 | <section id='how-to-submit-a-change'> |