[PATCH 1/3] kernel-dev,ref-manual: fix old override syntax

[PATCH 1/3] kernel-dev,ref-manual: fix old override syntax

[Ulrich Ölmann]

Additionally use more common syntax to indicate that an actual machine name is
supposed to be filled in for a concrete use case as has been suggested by Peter
Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in
the reference manual.

Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 documentation/kernel-dev/common.rst    | 2 +-
 documentation/ref-manual/variables.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index dff8f504fd6f..3c8e0b74e9b5 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -649,7 +649,7 @@ append files, you can direct the OpenEmbedded build system to use a
 To specify an "in-tree" ``defconfig`` file, use the following statement
 form::
 
-   KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file"
+   KBUILD_DEFCONFIG:<machine> ?= "defconfig_file"
 
 Here is an example
 that assigns the :term:`KBUILD_DEFCONFIG` variable based on "raspberrypi2"
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index a36c4c6df962..54da54f71d72 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:<machine> ?= "defconfig_file"
 
       Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
       a ``defconfig`` file named "bcm2709_defconfig"::
-- 
2.30.2

[PATCH 2/3] ref-manual: refer to MACHINE variable instead of KMACHINE

[Ulrich Ölmann]

Although in the example case of a "raspberrypi2" the variable KMACHINE has the
same value as MACHINE, only the latter is an allowed override. So do not set the
reader on the wrong track.

Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
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 54da54f71d72..62176f7ee8f1 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4277,7 +4277,7 @@ system and gives an overview of their function and contents.
 
          KBUILD_DEFCONFIG:<machine> ?= "defconfig_file"
 
-      Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
+      Here is an example from a "raspberrypi2" :term:`MACHINE` build that uses
       a ``defconfig`` file named "bcm2709_defconfig"::
 
          KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig"
-- 
2.30.2

[PATCH 3/3] kernel-dev: harmonize example with ref-manual

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 documentation/kernel-dev/common.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 3c8e0b74e9b5..e0a85575c104 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -651,10 +651,10 @@ form::
 
    KBUILD_DEFCONFIG:<machine> ?= "defconfig_file"
 
-Here is an example
-that assigns the :term:`KBUILD_DEFCONFIG` variable based on "raspberrypi2"
-and provides the path to the "in-tree" ``defconfig`` file to be used for
-a Raspberry Pi 2, which is based on the Broadcom 2708/2709 chipset::
+Here is an example that assigns the :term:`KBUILD_DEFCONFIG` variable utilizing
+an override for the "raspberrypi2" :term:`MACHINE` and provides the path to the
+"in-tree" ``defconfig`` file to be used for a Raspberry Pi 2, which is based on
+the Broadcom 2708/2709 chipset::
 
    KBUILD_DEFCONFIG:raspberrypi2 ?= "bcm2709_defconfig"
 
-- 
2.30.2

Re: [PATCH 1/3] kernel-dev,ref-manual: fix old override syntax

[Quentin Schulz]

Hi Ulrich,

Thanks for the patches.

For the whole series:
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

Cheers,
Quentin

On 2/13/23 15:35, Ulrich Ölmann wrote:
> Additionally use more common syntax to indicate that an actual machine name is
> supposed to be filled in for a concrete use case as has been suggested by Peter
> Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in
> the reference manual.
> 
> Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
> ---
>   documentation/kernel-dev/common.rst    | 2 +-
>   documentation/ref-manual/variables.rst | 2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
> index dff8f504fd6f..3c8e0b74e9b5 100644
> --- a/documentation/kernel-dev/common.rst
> +++ b/documentation/kernel-dev/common.rst
> @@ -649,7 +649,7 @@ append files, you can direct the OpenEmbedded build system to use a
>   To specify an "in-tree" ``defconfig`` file, use the following statement
>   form::
>   
> -   KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file"
> +   KBUILD_DEFCONFIG:<machine> ?= "defconfig_file"
>   
>   Here is an example
>   that assigns the :term:`KBUILD_DEFCONFIG` variable based on "raspberrypi2"
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index a36c4c6df962..54da54f71d72 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:<machine> ?= "defconfig_file"
>   
>         Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
>         a ``defconfig`` file named "bcm2709_defconfig"::

Re: [docs] [PATCH 1/3] kernel-dev,ref-manual: fix old override syntax

[Michael Opdenacker]

Ulrich,
Many thanks for the patches!

Quentin, Peter,
Thanks for the reviews!

On 13.02.23 at 15:59, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Ulrich,
>
> Thanks for the patches.
>
> For the whole series:
> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

Merged into "master-next".
Never too late for further comments, if any, of course.
Thanks again
Michael.

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