ref-manual: document new patch-status-* QA checks

Newly added in 4.2.

(From yocto-docs rev: 12e576fb6a932c4089651371c71c61fd1e96cd48)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton
2023-04-22 15:19:45 +12:00
committed by Richard Purdie
parent 1b9bcc7b19
commit 23d946b9ba
2 changed files with 30 additions and 0 deletions

View File

@@ -1336,6 +1336,13 @@ Here are the tests you can list with the :term:`WARN_QA` and
- ``patch-fuzz:`` Checks for fuzz in patch files that may allow
them to apply incorrectly if the underlying code changes.
- ``patch-status-core:`` Checks that the Upstream-Status is specified
and valid in the headers of patches for recipes in the OE-Core layer.
- ``patch-status-noncore:`` Checks that the Upstream-Status is specified
and valid in the headers of patches for recipes in layers other than
OE-Core.
- ``perllocalpod:`` Checks for ``perllocal.pod`` being erroneously
installed and packaged by a recipe.

View File

@@ -750,6 +750,29 @@ Errors and Warnings
other things in the patches, those can be discarded.
.. _qa-check-patch-status:
- ``Missing Upstream-Status in patch <patchfile> Please add according to <url> [patch-status-core/patch-status-noncore]``
The Upstream-Status value is missing in the specified patch file's header.
This value is intended to track whether or not the patch has been sent
upstream, whether or not it has been merged, etc.
There are two options for this same check - ``patch-status-core`` (for
recipes in OE-Core) and ``patch-status-noncore`` (for recipes in any other
layer).
For more information on setting Upstream-Status see:
https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines#Patch_Header_Recommendations:_Upstream-Status
- ``Malformed Upstream-Status in patch <patchfile> Please correct according to <url> [patch-status-core/patch-status-noncore]``
The Upstream-Status value in the specified patch file's header is invalid -
it must be a specific format. See the "Missing Upstream-Status" entry above
for more information.
.. _qa-check-buildpaths:
- ``File <filename> in package <packagename> contains reference to TMPDIR [buildpaths]``