Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: YP docs mailing list <docs@lists.yoctoproject.org>
Subject: [PATCH] ref-manual: document variable and task for kernel version check
Date: Fri, 3 Jul 2026 09:25:12 -0400 (EDT)	[thread overview]
Message-ID: <57f7256c-e8b5-c425-0fb8-7699b0cbdb5d@crashcourse.ca> (raw)


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 <rpjday@crashcourse.ca>

---

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.


             reply	other threads:[~2026-07-03 13:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-03 13:25 Robert P. J. Day [this message]
2026-07-03 14:03 ` [docs] [PATCH] ref-manual: document variable and task for kernel version check Antonin Godard
2026-07-03 14:34   ` Robert P. J. Day
2026-07-20 15:30     ` Quentin Schulz
2026-07-04 16:17   ` Robert P. J. Day

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=57f7256c-e8b5-c425-0fb8-7699b0cbdb5d@crashcourse.ca \
    --to=rpjday@crashcourse.ca \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox