diff mbox series

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

Message ID 57f7256c-e8b5-c425-0fb8-7699b0cbdb5d@crashcourse.ca
State New
Headers show
Series ref-manual: document variable and task for kernel version check | expand

Commit Message

Robert P. J. Day July 3, 2026, 1:25 p.m. UTC
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>

---

Comments

Antonin Godard July 3, 2026, 2:03 p.m. UTC | #1
Hi,

On Fri Jul 3, 2026 at 3:25 PM CEST, Robert P. J. Day wrote:
>
> 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

This doesn't explain what this task does.

Antonin
Robert P. J. Day July 3, 2026, 2:34 p.m. UTC | #2
On Fri, 3 Jul 2026, Antonin Godard via lists.yoctoproject.org wrote:

> Hi,
>
> On Fri Jul 3, 2026 at 3:25 PM CEST, Robert P. J. Day wrote:
> >
> > 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
>
> This doesn't explain what this task does.

  Have you *seen* the RE/pattern checking in that task? I'm open to a
meaningful one-line descriptor.

rday
diff mbox series

Patch

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.