[PATCH] documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

[PATCH] documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

[joerg.sommer]

From: Jörg Sommer <joerg.sommer@navimatix.de>

UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
documented. To show its usage another example from the meta-freescale layer
was picked.

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
---
 documentation/ref-manual/classes.rst   |  2 +-
 documentation/ref-manual/variables.rst | 33 ++++++++++++++++----------
 2 files changed, 21 insertions(+), 14 deletions(-)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 6074ea0f52..471ac57ca5 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -3141,7 +3141,7 @@ The :ref:`ref-classes-uboot-config` class provides support for U-Boot configurat
 a machine. Specify the machine in your recipe as follows::
 
    UBOOT_CONFIG ??= <default>
-   UBOOT_CONFIG[foo] = "config,images"
+   UBOOT_CONFIG[foo] = "config,images,binary"
 
 You can also specify the machine using this method::
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index fe0b993bd8..ae14c450dd 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8932,23 +8932,30 @@ system and gives an overview of their function and contents.
       See the machine include files in the :term:`Source Directory`
       for these features.
 
+   :term:`UBOOT_BINARY`
+      Specifies the name of the binary build by U-Boot.
+
    :term:`UBOOT_CONFIG`
-      Configures the :term:`UBOOT_MACHINE` and can
-      also define :term:`IMAGE_FSTYPES` for individual
-      cases.
+      Configures one or more U-Boot configurations to build. Each
+      configuration can define the :term:`UBOOT_MACHINE` and optionally the
+      :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`.
 
-      Following is an example from the ``meta-fsl-arm`` layer. ::
+      Following is an example from the ``meta-freescale`` layer. ::
 
-         UBOOT_CONFIG ??= "sd"
-         UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard"
-         UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config"
-         UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs"
-         UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config"
+         UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor"
+         UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig"
+         UBOOT_CONFIG[sdcard-ifc] = "ls1021atwr_sdcard_ifc_defconfig,,u-boot-with-spl-pbl.bin"
+         UBOOT_CONFIG[sdcard-qspi] = "ls1021atwr_sdcard_qspi_defconfig,,u-boot-with-spl-pbl.bin"
+         UBOOT_CONFIG[lpuart] = "ls1021atwr_nor_lpuart_defconfig"
+         UBOOT_CONFIG[qspi] = "ls1021atwr_qspi_defconfig"
+         UBOOT_CONFIG[secure-boot] = "ls1021atwr_nor_SECURE_BOOT_defconfig"
+         UBOOT_CONFIG[sdcard-ifc-secure-boot] = "ls1021atwr_sdcard_ifc_SECURE_BOOT_defconfig,,u-boot-with-spl-pbl.bin"
 
-      In this example, "sd" is selected as the configuration of the possible four for the
-      :term:`UBOOT_MACHINE`. The "sd" configuration defines
-      "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the
-      "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image.
+      In this example, all possible seven configurations are selected. Each
+      configuration specifies "..._defconfig" as :term:`UBOOT_MACHINE`, and
+      the "sd..." configurations define an individual name for
+      :term:`UBOOT_BINARY`. No configuration defines a second parameter for
+      :term:`IMAGE_FSTYPES` to use for the U-Boot image.
 
       For more information on how the :term:`UBOOT_CONFIG` is handled, see the
       :ref:`uboot-config <ref-classes-uboot-config>`
-- 
2.34.1

Re: [docs] [PATCH] documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

[Michael Opdenacker]

Hi Jörg

On 29.12.23 at 11:29, Jörg Sommer via lists.yoctoproject.org wrote:
> From: Jörg Sommer<joerg.sommer@navimatix.de>
>
> UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
> documented. To show its usage another example from the meta-freescale layer
> was picked.

Thanks for the patch!
I'd like to merge it, but it doesn't apply when I save your e-mail to a 
".eml" file and run it through "git am".

Did you send it with "git send-email"? Looking at the message source, 
some lines are mangled.

As the patch looks correct in the e-mail received on the mailing list, 
you could this time send it to me as a regular attachment, and try to 
send your next patch with "git send-email".

Thanks in advance
Cheers
Michael.

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

Re: [docs] [PATCH] documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

[Jörg Sommer]

On 08.01.24 15:59, Michael Opdenacker wrote:
> Hi Jörg
> 
> On 29.12.23 at 11:29, Jörg Sommer via lists.yoctoproject.org wrote:
>> From: Jörg Sommer<joerg.sommer@navimatix.de>
>>
>> UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
>> documented. To show its usage another example from the meta-freescale
>> layer
>> was picked.
> 
> Thanks for the patch!
> I'd like to merge it, but it doesn't apply when I save your e-mail to a
> ".eml" file and run it through "git am".
> 
> Did you send it with "git send-email"? Looking at the message source,
> some lines are mangled.

Yes, I've used `git send-email --to docs@lists.yoctoproject.org -1`. I
resend it and set you as a direct recipient.


Kind regards

Jörg Sommer
-- 
Navimatix GmbH
Tatzendpromenade 2
D-07745 Jena
Geschäftsführer: Steffen Späthe, Jan Rommeley
Registergericht: Amtsgericht Jena, HRB 501480

Re: [docs] [PATCH] documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

[Michael Opdenacker]

Hi Jörg,

On 09.01.24 at 12:38, Jörg Sommer wrote:
> On 08.01.24 15:59, Michael Opdenacker wrote:
>> Hi Jörg
>>
>> On 29.12.23 at 11:29, Jörg Sommer via lists.yoctoproject.org wrote:
>>> From: Jörg Sommer<joerg.sommer@navimatix.de>
>>>
>>> UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
>>> documented. To show its usage another example from the meta-freescale
>>> layer
>>> was picked.
>> Thanks for the patch!
>> I'd like to merge it, but it doesn't apply when I save your e-mail to a
>> ".eml" file and run it through "git am".
>>
>> Did you send it with "git send-email"? Looking at the message source,
>> some lines are mangled.
> Yes, I've used `git send-email --to docs@lists.yoctoproject.org -1`. I
> resend it and set you as a direct recipient.

Weird that it didn't work in the first place.
Thanks for the new submission. I managed to apply it.

Thanks again
Michael.

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