From 0c8b5d0e697c344585062ac08b1c5e8ef4ce5758 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Thu, 10 Aug 2023 11:32:54 +0200 Subject: contributor guide: call section "Reporting a defect" Instead of "Submitting a defect". We all write bugs, and nobody needs documentation support for doing so! (From yocto-docs rev: ce94f6ed029afc8c69e84354c03bd0a9ab14f867) Signed-off-by: Michael Opdenacker Reported-by: Joshua Watt Signed-off-by: Richard Purdie --- documentation/contributor-guide/index.rst | 2 +- documentation/contributor-guide/report-defect.rst | 67 +++++++++++++++++++++++ documentation/contributor-guide/submit-defect.rst | 67 ----------------------- documentation/dev-manual/debugging.rst | 2 +- documentation/ref-manual/resources.rst | 2 +- documentation/ref-manual/system-requirements.rst | 2 +- 6 files changed, 71 insertions(+), 71 deletions(-) create mode 100644 documentation/contributor-guide/report-defect.rst delete mode 100644 documentation/contributor-guide/submit-defect.rst (limited to 'documentation') diff --git a/documentation/contributor-guide/index.rst b/documentation/contributor-guide/index.rst index 7a39f994e2..8fa65045a3 100644 --- a/documentation/contributor-guide/index.rst +++ b/documentation/contributor-guide/index.rst @@ -19,7 +19,7 @@ this. :numbered: identify-component - submit-defect + report-defect recipe-style-guide submit-change diff --git a/documentation/contributor-guide/report-defect.rst b/documentation/contributor-guide/report-defect.rst new file mode 100644 index 0000000000..8ef133b842 --- /dev/null +++ b/documentation/contributor-guide/report-defect.rst @@ -0,0 +1,67 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Reporting a Defect Against the Yocto Project and OpenEmbedded +************************************************************** + +You can use the Yocto Project instance of +`Bugzilla `__ to submit a defect (bug) +against BitBake, OpenEmbedded-Core, against any other Yocto Project component +or for tool issues. For additional information on this implementation of +Bugzilla see the ":ref:`Yocto Project Bugzilla `" section +in the Yocto Project Reference Manual. For more detail on any of the following +steps, see the Yocto Project +:yocto_wiki:`Bugzilla wiki page `. + +Use the following general steps to submit a bug: + +#. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. + +#. Click "File a Bug" to enter a new bug. + +#. Choose the appropriate "Classification", "Product", and "Component" + for which the bug was found. Bugs for the Yocto Project fall into + one of several classifications, which in turn break down into + several products and components. For example, for a bug against the + ``meta-intel`` layer, you would choose "Build System, Metadata & + Runtime", "BSPs", and "bsps-meta-intel", respectively. + +#. Choose the "Version" of the Yocto Project for which you found the + bug (e.g. &DISTRO;). + +#. Determine and select the "Severity" of the bug. The severity + indicates how the bug impacted your work. + +#. Choose the "Hardware" that the bug impacts. + +#. Choose the "Architecture" that the bug impacts. + +#. Choose a "Documentation change" item for the bug. Fixing a bug might + or might not affect the Yocto Project documentation. If you are + unsure of the impact to the documentation, select "Don't Know". + +#. Provide a brief "Summary" of the bug. Try to limit your summary to + just a line or two and be sure to capture the essence of the bug. + +#. Provide a detailed "Description" of the bug. You should provide as + much detail as you can about the context, behavior, output, and so + forth that surrounds the bug. You can even attach supporting files + for output from logs by using the "Add an attachment" button. + +#. Click the "Submit Bug" button submit the bug. A new Bugzilla number + is assigned to the bug and the defect is logged in the bug tracking + system. + +Once you file a bug, the bug is processed by the Yocto Project Bug +Triage Team and further details concerning the bug are assigned (e.g. +priority and owner). You are the "Submitter" of the bug and any further +categorization, progress, or comments on the bug result in Bugzilla +sending you an automated email concerning the particular change or +progress to the bug. + +There are no guarantees about if or when a bug might be worked on since an +open-source project has no dedicated engineering resources. However, the +project does have a good track record of resolving common issues over the +medium and long term. We do encourage people to file bugs so issues are +at least known about. It helps other users when they find somebody having +the same issue as they do, and an issue that is unknown is much less likely +to ever be fixed! diff --git a/documentation/contributor-guide/submit-defect.rst b/documentation/contributor-guide/submit-defect.rst deleted file mode 100644 index 527ffb2dc0..0000000000 --- a/documentation/contributor-guide/submit-defect.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -Submitting a Defect Against the Yocto Project and OpenEmbedded -************************************************************** - -You can use the Yocto Project instance of -`Bugzilla `__ to submit a defect (bug) -against BitBake, OpenEmbedded-Core, against any other Yocto Project component -or for tool issues. For additional information on this implementation of -Bugzilla see the ":ref:`Yocto Project Bugzilla `" section -in the Yocto Project Reference Manual. For more detail on any of the following -steps, see the Yocto Project -:yocto_wiki:`Bugzilla wiki page `. - -Use the following general steps to submit a bug: - -#. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. - -#. Click "File a Bug" to enter a new bug. - -#. Choose the appropriate "Classification", "Product", and "Component" - for which the bug was found. Bugs for the Yocto Project fall into - one of several classifications, which in turn break down into - several products and components. For example, for a bug against the - ``meta-intel`` layer, you would choose "Build System, Metadata & - Runtime", "BSPs", and "bsps-meta-intel", respectively. - -#. Choose the "Version" of the Yocto Project for which you found the - bug (e.g. &DISTRO;). - -#. Determine and select the "Severity" of the bug. The severity - indicates how the bug impacted your work. - -#. Choose the "Hardware" that the bug impacts. - -#. Choose the "Architecture" that the bug impacts. - -#. Choose a "Documentation change" item for the bug. Fixing a bug might - or might not affect the Yocto Project documentation. If you are - unsure of the impact to the documentation, select "Don't Know". - -#. Provide a brief "Summary" of the bug. Try to limit your summary to - just a line or two and be sure to capture the essence of the bug. - -#. Provide a detailed "Description" of the bug. You should provide as - much detail as you can about the context, behavior, output, and so - forth that surrounds the bug. You can even attach supporting files - for output from logs by using the "Add an attachment" button. - -#. Click the "Submit Bug" button submit the bug. A new Bugzilla number - is assigned to the bug and the defect is logged in the bug tracking - system. - -Once you file a bug, the bug is processed by the Yocto Project Bug -Triage Team and further details concerning the bug are assigned (e.g. -priority and owner). You are the "Submitter" of the bug and any further -categorization, progress, or comments on the bug result in Bugzilla -sending you an automated email concerning the particular change or -progress to the bug. - -There are no guarantees about if or when a bug might be worked on since an -open-source project has no dedicated engineering resources. However, the -project does have a good track record of resolving common issues over the -medium and long term. We do encourage people to file bugs so issues are -at least known about. It helps other users when they find somebody having -the same issue as they do, and an issue that is unknown is much less likely -to ever be fixed! diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 3a8d5080ce..890578cc05 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst @@ -1235,7 +1235,7 @@ Here are some other tips that you might find useful: :yocto_bugs:`Bugzilla <>`. For information on how to submit a bug against the Yocto Project, see the Yocto Project Bugzilla :yocto_wiki:`wiki page ` - and the ":doc:`../contributor-guide/submit-defect`" section. + and the ":doc:`../contributor-guide/report-defect`" section. .. note:: diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 324d1fad10..8c3726e83b 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -45,7 +45,7 @@ your expectations). For a general procedure and guidelines on how to use Bugzilla to submit a bug against the Yocto Project, see the following: -- The ":doc:`../contributor-guide/submit-defect`" +- The ":doc:`../contributor-guide/report-defect`" section in the Yocto Project and OpenEmbedded Contributor Guide. - The Yocto Project :yocto_wiki:`Bugzilla wiki page ` diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index d1c440cf19..e1ff51c859 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst @@ -134,7 +134,7 @@ tested on former revisions of "&DISTRO_NAME;", but no longer are: interested in hearing about your experience. For information on how to submit a bug, see the Yocto Project :yocto_wiki:`Bugzilla wiki page ` - and the ":doc:`../contributor-guide/submit-defect`" + and the ":doc:`../contributor-guide/report-defect`" section in the Yocto Project and OpenEmbedded Contributor Guide. Required Packages for the Build Host -- cgit v1.2.3-54-g00ecf