diff mbox series

[09/17] ref-manual: document new patch-status-* QA checks

Message ID 0af28e2c3e4d2f4d4d1ff47a81973c56341bcc78.1682133339.git.bluelightning@bluelightning.org
State New
Headers show
Series [01/17] ref-manual: add new SDK_ZIP_OPTIONS variable | expand

Commit Message

Paul Eggleton April 22, 2023, 3:19 a.m. UTC
Newly added in 4.2.

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
 documentation/ref-manual/classes.rst   |  7 +++++++
 documentation/ref-manual/qa-checks.rst | 23 +++++++++++++++++++++++
 2 files changed, 30 insertions(+)
diff mbox series


diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index aacbb8a495c..0762d1d8bc8 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -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.
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 13096816d2e..6fdb0fbde9a 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -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]``