1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Reporting a Defect Against the Yocto Project and OpenEmbedded
4**************************************************************
5
6You can use the Yocto Project instance of
7`Bugzilla <https://www.bugzilla.org/about/>`__ to submit a defect (bug)
8against BitBake, OpenEmbedded-Core, against any other Yocto Project component
9or for tool issues. For additional information on this implementation of
10Bugzilla see the ":ref:`Yocto Project Bugzilla <resources-bugtracker>`" section
11in the Yocto Project Reference Manual. For more detail on any of the following
12steps, see the Yocto Project
13:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`.
14
15Use the following general steps to submit a bug:
16
17#.  Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`.
18
19#.  Click "File a Bug" to enter a new bug.
20
21#.  Choose the appropriate "Classification", "Product", and "Component"
22    for which the bug was found. Bugs for the Yocto Project fall into
23    one of several classifications, which in turn break down into
24    several products and components. For example, for a bug against the
25    ``meta-intel`` layer, you would choose "Build System, Metadata &
26    Runtime", "BSPs", and "bsps-meta-intel", respectively.
27
28#.  Choose the "Version" of the Yocto Project for which you found the
29    bug (e.g. &DISTRO;).
30
31#.  Determine and select the "Severity" of the bug. The severity
32    indicates how the bug impacted your work.
33
34#.  Choose the "Hardware" that the bug impacts.
35
36#.  Choose the "Architecture" that the bug impacts.
37
38#.  Choose a "Documentation change" item for the bug. Fixing a bug might
39    or might not affect the Yocto Project documentation. If you are
40    unsure of the impact to the documentation, select "Don't Know".
41
42#.  Provide a brief "Summary" of the bug. Try to limit your summary to
43    just a line or two and be sure to capture the essence of the bug.
44
45#.  Provide a detailed "Description" of the bug. You should provide as
46    much detail as you can about the context, behavior, output, and so
47    forth that surrounds the bug. You can even attach supporting files
48    for output from logs by using the "Add an attachment" button.
49
50#.  Click the "Submit Bug" button submit the bug. A new Bugzilla number
51    is assigned to the bug and the defect is logged in the bug tracking
52    system.
53
54Once you file a bug, the bug is processed by the Yocto Project Bug
55Triage Team and further details concerning the bug are assigned (e.g.
56priority and owner). You are the "Submitter" of the bug and any further
57categorization, progress, or comments on the bug result in Bugzilla
58sending you an automated email concerning the particular change or
59progress to the bug.
60
61There are no guarantees about if or when a bug might be worked on since an
62open-source project has no dedicated engineering resources. However, the
63project does have a good track record of resolving common issues over the
64medium and long term. We do encourage people to file bugs so issues are
65at least known about. It helps other users when they find somebody having
66the same issue as they do, and an issue that is unknown is much less likely
67to ever be fixed!
68