[PATCH] ref-manual: document variable and task for kernel version check

"Robert P. J. Day" <[email protected]> Fri, 3 Jul 2026 09:25:12 -0400 (EDT)
Newsgroups org.yoctoproject.lists.docs
Message-ID <[email protected]>
Add the associated variable and task for kernel version checking:

  - do_kernel_version_sanity_check()
  - KERNEL_VERSION_SANITY_SKIP

Signed-off-by: Robert P. J. Day <[email protected]>

---

diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index e1db2d5ed..5744d47dc 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -787,6 +787,14 @@ which can then be applied by subsequent tasks such as
 :ref:`ref-tasks-patch` and
 :ref:`ref-tasks-kernel_configme`.

+.. _ref-tasks-kernel_version_sanity_check:
+
+``do_kernel_version_sanity_check``
+----------------------------------
+
+Validate the version of the kernel; skip this check by assigning the
+value "1" to :term:`KERNEL_VERSION_SANITY_SKIP`.
+
 .. _ref-tasks-menuconfig:

 ``do_menuconfig``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c92b195ff..e99b623ea 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5748,6 +5748,10 @@ system and gives an overview of their function and contents.
       configured. Consequently, attempting to refer to this variable in
       contexts prior to configuration will not work.

+   :term:`KERNEL_VERSION_SANITY_SKIP`
+      If set to "1", skip the
+      :ref:`ref-tasks-kernel_version_sanity_check` task.
+
    :term:`KERNELDEPMODDEPEND`
       Specifies whether the data referenced through
       :term:`PKGDATA_DIR` is needed or not.