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

Hi,

On 7/3/26 4:34 PM, Robert P. J. Day via lists.yoctoproject.org wrote:
> 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 <[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
>>
>> 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.
> 

It makes sure that the PV of the kernel recipe matches the value stored 
in the root Makefile in the kernel sources (SUBLEVEL may be ignored if 0).

This task also only exists if the kernel.bbclass is inherited, so this 
needs to be made explicit in the task description. And it is only called 
if kernel-yocto.bbclass is inherited, otherwise it is simply a function 
(it is not added in the task tree in kernel.bbclass).

Also, why would you want to disable the version sanity check... I'm not 
sure. I guess you could say something along the lines of "may be used 
for a rolling version of the kernel that is often rebased, e.g. 
linux-yocto-dev. This should typically not be set to 1 as it may mislead 
the user as to which version of the kernel is actually being built or 
installed."

Cheers,
Quentin