diff mbox series

[1/9] ref-manual: Add virtual-slash QA check

Message ID 3671c8f7bd572b795bb5075bcdcdc4d808b85021.1713127068.git.bluelightning@bluelightning.org
State New
Headers show
Series [1/9] ref-manual: Add virtual-slash QA check | expand

Commit Message

Paul Eggleton April 14, 2024, 8:43 p.m. UTC
Add the new virtual-slash QA check to the insane class section and the
QA checks section.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
 documentation/ref-manual/classes.rst   | 6 ++++++
 documentation/ref-manual/qa-checks.rst | 8 ++++++++
 2 files changed, 14 insertions(+)
diff mbox series


diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 1d01456ece..296347edb7 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1582,6 +1582,12 @@  The tests you can list with the :term:`WARN_QA` and
       This is only relevant when you are using runtime package management
       on your target system.
+-  ``virtual-slash:`` Checks to see if ``virtual/`` is being used in
+   :term:`RDEPENDS` or :term:`RPROVIDES`, which is not good practice -
+   ``virtual/`` is a convention intended for use in the build context
+   (i.e. :term:`PROVIDES` and :term:`DEPENDS`) rather than the runtime
+   context.
 -  ``xorg-driver-abi:`` Checks that all packages containing Xorg
    drivers have ABI dependencies. The ``xserver-xorg`` recipe provides
    driver ABI names. All drivers should depend on the ABI versions that
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 58526a0e57..53b1836e74 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -799,6 +799,14 @@  Errors and Warnings
     section in the Yocto Project Development Tasks Manual. See also the
     ":ref:`ref-classes-ptest`" section.
+.. _qa-check-virtual-slash:
+- ``<variable> is set to <value> but the substring 'virtual/' holds no meaning in this context. It only works for build time dependencies, not runtime ones. It is suggested to use 'VIRTUAL-RUNTIME_' variables instead.``
+    ``virtual/`` is a convention intended for use in the build context
+    (i.e. :term:`PROVIDES` and :term:`DEPENDS`) rather than the runtime
+    context (i.e. :term:`RPROVIDES` and :term:`RDEPENDS`). Use
+    :term:`VIRTUAL-RUNTIME` variables instead for the latter.
 Configuring and Disabling QA Checks