[PATCH] ref-manual: document KERNEL_LOCALVERSION

[PATCH] ref-manual: document KERNEL_LOCALVERSION

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Introduced by
https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Bruce Ashfield <bruce.ashfield@gmail.com>
---
 documentation/ref-manual/variables.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 03234d3f78..771eb91af6 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
       external tools. See the :ref:`ref-classes-kernel-yocto` class in
       ``meta/classes-recipe`` to see how the variable is used.
 
+   :term:`KERNEL_LOCALVERSION`
+      This variable allows to appends a string to the version
+      of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
+      kernel configuration parameter.
+
+      Using this variable is only useful when you are using a kernel recipe
+      inheriting the :ref:`ref-classes-kernel` class, and which doesn't
+      already set a local version. Therefore, setting this variable has no
+      impact on ``linux-yocto`` kernels.
+
    :term:`EXTERNAL_TOOLCHAIN`
       When you intend to use an
       :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`,
-- 
2.34.1

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Daniel Ammann]

Hi Michael

Comment inline.

Kind regards

Daniel


On 10/27/23 11:29, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Introduced by
> https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
> ---
>   documentation/ref-manual/variables.rst | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 03234d3f78..771eb91af6 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
>         external tools. See the :ref:`ref-classes-kernel-yocto` class in
>         ``meta/classes-recipe`` to see how the variable is used.
>   
> +   :term:`KERNEL_LOCALVERSION`
> +      This variable allows to appends a string to the version

allows to append

> +      of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
> +      kernel configuration parameter.
> +
> +      Using this variable is only useful when you are using a kernel recipe
> +      inheriting the :ref:`ref-classes-kernel` class, and which doesn't
> +      already set a local version. Therefore, setting this variable has no
> +      impact on ``linux-yocto`` kernels.
> +
>      :term:`EXTERNAL_TOOLCHAIN`
>         When you intend to use an
>         :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`,
> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#4508): https://lists.yoctoproject.org/g/docs/message/4508
> Mute This Topic: https://lists.yoctoproject.org/mt/102217669/3616718
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [daniel.ammann@bytesatwork.ch]
> -=-=-=-=-=-=-=-=-=-=-=-
> 

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Michael Opdenacker]

Hi Daniel,

Thanks for the review!

On 27.10.23 at 13:27, Daniel Ammann wrote:
> Hi Michael
>
> Comment inline.
>
> Kind regards
>
> Daniel
>
>
> On 10/27/23 11:29, Michael Opdenacker via lists.yoctoproject.org wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Introduced by
>> https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0 
>>
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
>> ---
>>   documentation/ref-manual/variables.rst | 10 ++++++++++
>>   1 file changed, 10 insertions(+)
>>
>> diff --git a/documentation/ref-manual/variables.rst 
>> b/documentation/ref-manual/variables.rst
>> index 03234d3f78..771eb91af6 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -2485,6 +2485,16 @@ system and gives an overview of their function 
>> and contents.
>>         external tools. See the :ref:`ref-classes-kernel-yocto` class in
>>         ``meta/classes-recipe`` to see how the variable is used.
>>   +   :term:`KERNEL_LOCALVERSION`
>> +      This variable allows to appends a string to the version
>
> allows to append


Oops, good catch. Fixed in master-next.
Thanks again,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Ulrich Ölmann]

Hi Michael,

just a small typo, otherwise a good description.

On Fri, Oct 27 2023 at 11:29 +0200, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> Introduced by
> https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
> ---
>  documentation/ref-manual/variables.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 03234d3f78..771eb91af6 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
>        external tools. See the :ref:`ref-classes-kernel-yocto` class in
>        ``meta/classes-recipe`` to see how the variable is used.
>  
> +   :term:`KERNEL_LOCALVERSION`
> +      This variable allows to appends a string to the version

s/appends/append/

Thanks and best regards
Ulrich


> +      of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
> +      kernel configuration parameter.
> +
> +      Using this variable is only useful when you are using a kernel recipe
> +      inheriting the :ref:`ref-classes-kernel` class, and which doesn't
> +      already set a local version. Therefore, setting this variable has no
> +      impact on ``linux-yocto`` kernels.
> +
>     :term:`EXTERNAL_TOOLCHAIN`
>        When you intend to use an
>        :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`,
-- 
Pengutronix e.K.                           | Ulrich Ölmann               |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Ulrich Ölmann]

On Thu, Nov 02 2023 at 10:55 +0100, Ulrich Ölmann <u.oelmann@pengutronix.de> wrote:
> Hi Michael,
>
> just a small typo, otherwise a good description.
>
> On Fri, Oct 27 2023 at 11:29 +0200, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Introduced by
>> https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
>> ---
>>  documentation/ref-manual/variables.rst | 10 ++++++++++
>>  1 file changed, 10 insertions(+)
>>
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index 03234d3f78..771eb91af6 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
>>        external tools. See the :ref:`ref-classes-kernel-yocto` class in
>>        ``meta/classes-recipe`` to see how the variable is used.
>>  
>> +   :term:`KERNEL_LOCALVERSION`
>> +      This variable allows to appends a string to the version
>
> s/appends/append/

Urgs, it's better to read the whole thread before replying - this has
already been addressed before. Sorry for the noise!

Best regards
Ulrich


> Thanks and best regards
> Ulrich
>
>
>> +      of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
>> +      kernel configuration parameter.
>> +
>> +      Using this variable is only useful when you are using a kernel recipe
>> +      inheriting the :ref:`ref-classes-kernel` class, and which doesn't
>> +      already set a local version. Therefore, setting this variable has no
>> +      impact on ``linux-yocto`` kernels.
>> +
>>     :term:`EXTERNAL_TOOLCHAIN`
>>        When you intend to use an
>>        :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`,
-- 
Pengutronix e.K.                           | Ulrich Ölmann               |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Michael Opdenacker]

On 02.11.23 at 11:01, Ulrich Ölmann wrote:
> On Thu, Nov 02 2023 at 10:55 +0100, Ulrich Ölmann <u.oelmann@pengutronix.de> wrote:
>> Hi Michael,
>>
>> just a small typo, otherwise a good description.
>>
>> On Fri, Oct 27 2023 at 11:29 +0200, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>>
>>> Introduced by
>>> https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
>>>
>>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
>>> ---
>>>   documentation/ref-manual/variables.rst | 10 ++++++++++
>>>   1 file changed, 10 insertions(+)
>>>
>>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>>> index 03234d3f78..771eb91af6 100644
>>> --- a/documentation/ref-manual/variables.rst
>>> +++ b/documentation/ref-manual/variables.rst
>>> @@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
>>>         external tools. See the :ref:`ref-classes-kernel-yocto` class in
>>>         ``meta/classes-recipe`` to see how the variable is used.
>>>   
>>> +   :term:`KERNEL_LOCALVERSION`
>>> +      This variable allows to appends a string to the version
>> s/appends/append/
> Urgs, it's better to read the whole thread before replying - this has
> already been addressed before. Sorry for the noise!

No problem, I sometimes do this too.
Thanks for the review anyway!
Cheers
Michael.


-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Robert P. J. Day]

[-- Attachment #1: Type: text/plain, Size: 1384 bytes --]

On Thu, 2 Nov 2023, Ulrich Ölmann wrote:

> Hi Michael,
>
> just a small typo, otherwise a good description.
>
> On Fri, Oct 27 2023 at 11:29 +0200, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
> > From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> >
> > Introduced by
> > https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
> >
> > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > CC: Bruce Ashfield <bruce.ashfield@gmail.com>
> > ---
> >  documentation/ref-manual/variables.rst | 10 ++++++++++
> >  1 file changed, 10 insertions(+)
> >
> > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> > index 03234d3f78..771eb91af6 100644
> > --- a/documentation/ref-manual/variables.rst
> > +++ b/documentation/ref-manual/variables.rst
> > @@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
> >        external tools. See the :ref:`ref-classes-kernel-yocto` class in
> >        ``meta/classes-recipe`` to see how the variable is used.
> >
> > +   :term:`KERNEL_LOCALVERSION`
> > +      This variable allows to appends a string to the version
>
> s/appends/append/

  i don't like that variation either ... why not just "allows
appending". or, better yet, "supports appending"?

rday

Re: [docs] [PATCH] ref-manual: document KERNEL_LOCALVERSION

[Michael Opdenacker]

On 02.11.23 at 15:52, Robert P. J. Day wrote:
> On Thu, 2 Nov 2023, Ulrich Ölmann wrote:
>
>> Hi Michael,
>>
>> just a small typo, otherwise a good description.
>>
>> On Fri, Oct 27 2023 at 11:29 +0200, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>>
>>> Introduced by
>>> https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
>>>
>>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
>>> ---
>>>   documentation/ref-manual/variables.rst | 10 ++++++++++
>>>   1 file changed, 10 insertions(+)
>>>
>>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>>> index 03234d3f78..771eb91af6 100644
>>> --- a/documentation/ref-manual/variables.rst
>>> +++ b/documentation/ref-manual/variables.rst
>>> @@ -2485,6 +2485,16 @@ system and gives an overview of their function and contents.
>>>         external tools. See the :ref:`ref-classes-kernel-yocto` class in
>>>         ``meta/classes-recipe`` to see how the variable is used.
>>>
>>> +   :term:`KERNEL_LOCALVERSION`
>>> +      This variable allows to appends a string to the version
>> s/appends/append/
>    i don't like that variation either ... why not just "allows
> appending". or, better yet, "supports appending"?

Oops, too late, as the commit already made it into "master".
Maybe you could send a wider patch replacing instances of "allows to" by 
something you think sounds better.

Thanks!
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com