diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-13 08:25:59 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-06-14 10:19:25 +0100 |
| commit | 741dddf11ae899eec6ed710daf005551f304563b (patch) | |
| tree | 9ed248ca23631feb9c96ba13a459204cfd89e547 /documentation/ref-manual | |
| parent | 0dae0865ba2be2322475b8877c25a45b56c79b48 (diff) | |
| download | poky-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>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/resources.xml | 36 | ||||
| -rw-r--r-- | documentation/ref-manual/usingpoky.xml | 8 |
2 files changed, 38 insertions, 6 deletions
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 |
