Re: [docs] [PATCH] ref-manual: add missing quotes

Re: [docs] [PATCH] ref-manual: add missing quotes

[Ulrich Ölmann]

Hi there,

On Sun, Feb 12 2023 at 22:41 +0100, Ulrich Ölmann <u.oelmann@pengutronix.de> wrote:
> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
> ---
>  documentation/ref-manual/variables.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index a36c4c6df962..c561aae6563a 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -4275,7 +4275,7 @@ system and gives an overview of their function and contents.
>        To use the variable, set it in the append file for your kernel recipe
>        using the following form::
>
> -         KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file
> +         KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file"

I did not find any occurance of a variable named "KBUILD_DEFCONFIG_
KMACHINE" in kernel-yocto.bbclass and from the above line's context my
feeling is that the last underscore was meant to be the old override
syntax which should be updated to ":" now. If this is correct then I
would additionally expect the override not to be KMACHINE but MACHINE
instead as only the latter is a valid override. Could someone with more
insight please confirm or reject my suspicion?

In case of positive feedback I would gladly send another patch doing a

  s/KBUILD_DEFCONFIG_KMACHINE/KBUILD_DEFCONFIG:MACHINE/

that changes both occurances in ref-manual/variables.rst and kernel-dev/
common.rst.

Best regards
Ulrich


>        Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
>        a ``defconfig`` file named "bcm2709_defconfig"::
-- 
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: add missing quotes

[Peter Kjellerstedt]

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf Of Ulrich Ölmann
> Sent: den 12 februari 2023 22:46
> To: docs@lists.yoctoproject.org
> Subject: Re: [docs] [PATCH] ref-manual: add missing quotes
> 
> Hi there,
> 
> On Sun, Feb 12 2023 at 22:41 +0100, Ulrich Ölmann <u.oelmann@pengutronix.de> wrote:
> > Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
> > ---
> >  documentation/ref-manual/variables.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> > index a36c4c6df962..c561aae6563a 100644
> > --- a/documentation/ref-manual/variables.rst
> > +++ b/documentation/ref-manual/variables.rst
> > @@ -4275,7 +4275,7 @@ system and gives an overview of their function and contents.
> >        To use the variable, set it in the append file for your kernel recipe
> >        using the following form::
> >
> > -         KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file
> > +         KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file"
> 
> I did not find any occurance of a variable named "KBUILD_DEFCONFIG_
> KMACHINE" in kernel-yocto.bbclass and from the above line's context my
> feeling is that the last underscore was meant to be the old override
> syntax which should be updated to ":" now. If this is correct then I
> would additionally expect the override not to be KMACHINE but MACHINE
> instead as only the latter is a valid override. Could someone with more
> insight please confirm or reject my suspicion?
> 
> In case of positive feedback I would gladly send another patch doing a
> 
>   s/KBUILD_DEFCONFIG_KMACHINE/KBUILD_DEFCONFIG:MACHINE/

I don't know what syntax is used in the manuals for indicating that 
something is expected to be replaced by an actual value, but I would 
expected it to be something like `KBUILD_DEFCONFIG:<machine>` to 
indicate that an actual machine name is supposed to be used instead 
of `<machine>`.

> 
> that changes both occurances in ref-manual/variables.rst and kernel-dev/
> common.rst.
> 
> Best regards
> Ulrich
> 
> 
> >        Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
> >        a ``defconfig`` file named "bcm2709_defconfig"::
> --
> 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 |

//Peter

Re: [docs] [PATCH] ref-manual: add missing quotes

[Quentin Schulz]

Hi Ulrich,

On 2/12/23 22:45, Ulrich Ölmann wrote:
> Hi there,
> 
> On Sun, Feb 12 2023 at 22:41 +0100, Ulrich Ölmann <u.oelmann@pengutronix.de> wrote:
>> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
>> ---
>>   documentation/ref-manual/variables.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index a36c4c6df962..c561aae6563a 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -4275,7 +4275,7 @@ system and gives an overview of their function and contents.
>>         To use the variable, set it in the append file for your kernel recipe
>>         using the following form::
>>
>> -         KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file
>> +         KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file"
> 
> I did not find any occurance of a variable named "KBUILD_DEFCONFIG_
> KMACHINE" in kernel-yocto.bbclass and from the above line's context my
> feeling is that the last underscore was meant to be the old override
> syntax which should be updated to ":" now.

That seems about right: 
https://git.yoctoproject.org/poky/commit/?id=c801d0425d442d05245274e71e7ccc9ff9f81915



> If this is correct then I
> would additionally expect the override not to be KMACHINE but MACHINE
> instead as only the latter is a valid override. Could someone with more
> insight please confirm or reject my suspicion?
> 

That seems about right too from my 5min of reading kernel-yocto.bbclass 
and also the examples that follow this "mistake" in the docs:
"""
Here is an example from a “raspberrypi2” KMACHINE build that uses a 
defconfig file named “bcm2709_defconfig”:

KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig"
"""

and I actually believe this should be saying
"""
Here is an example from a “raspberrypi2” :term:`MACHINE` build that uses 
a defconfig file named “bcm2709_defconfig:
"""

> In case of positive feedback I would gladly send another patch doing a
> 
>    s/KBUILD_DEFCONFIG_KMACHINE/KBUILD_DEFCONFIG:MACHINE/
> 
> that changes both occurances in ref-manual/variables.rst and kernel-dev/
> common.rst.
> 

Yes please :)

Nice catch!

Cheers,
Quentin

Re: [docs] [PATCH] ref-manual: add missing quotes

[Ulrich Ölmann]

On Sun, Feb 12 2023 at 22:41 +0100, Ulrich Ölmann <u.oelmann@pengutronix.de> wrote:
> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
> ---
>  documentation/ref-manual/variables.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index a36c4c6df962..c561aae6563a 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -4275,7 +4275,7 @@ system and gives an overview of their function and contents.
>        To use the variable, set it in the append file for your kernel recipe
>        using the following form::
>  
> -         KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file
> +         KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file"
>  
>        Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
>        a ``defconfig`` file named "bcm2709_defconfig"::

Please forget this one, just sent an update.

Best regards
Ulrich
-- 
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 |