[PATCH 1/2] ref-manual: improve documentation for SDKMACHINE

[PATCH 1/2] ref-manual: improve documentation for SDKMACHINE

[Ross Burton]

Signed-off-by: Ross Burton <ross.burton@arm.com>
---
 documentation/ref-manual/variables.rst | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index b9e97719b..1389bcc5d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6756,17 +6756,14 @@ system and gives an overview of their function and contents.
          $ bitbake -c populate_sdk imagename
 
    :term:`SDKMACHINE`
-      The machine for which the SDK is built. In other words, the SDK is
-      built such that it runs on the target you specify with the
-      :term:`SDKMACHINE` value. The value points to a corresponding ``.conf``
-      file under ``conf/machine-sdk/``.
-
-      You can use "i686" and "x86_64" as possible values for this variable.
-      The variable defaults to "i686" and is set in the local.conf file in
-      the Build Directory.
-      ::
-
-         SDKMACHINE ?= "i686"
+      The machine for which the SDK is built. In other words, the SDK is built
+      such that it runs on the target you specify with the :term:`SDKMACHINE`
+      value. The value points to a corresponding ``.conf`` file under
+      ``conf/machine-sdk/`` in the enabled layers, for example ``aarch64``,
+      ``i586``, ``i686``, ``ppc64``, ``ppc64le``, or ``x86_64``.
+
+      The variable defaults to :term:`BUILD_ARCH` so that SDKs are built for the
+      build machine.
 
       .. note::
 
-- 
2.25.1

[PATCH 2/2] kickstart: update busybox note regarding PARTUUID

[Ross Burton]

As of oe-core c996cabf the default BusyBox configuration supports
PARTUUID, so update the note to reflect this.

Signed-off-by: Ross Burton <ross.burton@arm.com>
---
 documentation/ref-manual/kickstart.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index cac9f2f49..807f5e052 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -54,8 +54,9 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or
 .. note::
 
    The mount program must understand the PARTUUID syntax you use with
-   ``--use-uuid`` and non-root *mountpoint*, including swap. The BusyBox
-   versions of these application are currently excluded.
+   ``--use-uuid`` and non-root *mountpoint*, including swap. The default
+   configuration of BusyBox in OpenEmbedded supports this, but this may
+   be disabled in custom configurations.
 
 Here is an example that uses "/" as the mountpoint. The command uses
 ``--ondisk`` to force the partition onto the ``sdb`` disk::
-- 
2.25.1

Re: [docs] [PATCH 1/2] ref-manual: improve documentation for SDKMACHINE

[Quentin Schulz]

Hi Ross,

On Mon, Nov 01, 2021 at 12:22:18PM +0000, Ross Burton wrote:
> Signed-off-by: Ross Burton <ross.burton@arm.com>
> ---
>  documentation/ref-manual/variables.rst | 19 ++++++++-----------
>  1 file changed, 8 insertions(+), 11 deletions(-)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index b9e97719b..1389bcc5d 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -6756,17 +6756,14 @@ system and gives an overview of their function and contents.
>           $ bitbake -c populate_sdk imagename
>  
>     :term:`SDKMACHINE`
> -      The machine for which the SDK is built. In other words, the SDK is
> -      built such that it runs on the target you specify with the
> -      :term:`SDKMACHINE` value. The value points to a corresponding ``.conf``
> -      file under ``conf/machine-sdk/``.
> -
> -      You can use "i686" and "x86_64" as possible values for this variable.
> -      The variable defaults to "i686" and is set in the local.conf file in
> -      the Build Directory.
> -      ::
> -
> -         SDKMACHINE ?= "i686"
> +      The machine for which the SDK is built. In other words, the SDK is built
> +      such that it runs on the target you specify with the :term:`SDKMACHINE`
> +      value. The value points to a corresponding ``.conf`` file under
> +      ``conf/machine-sdk/`` in the enabled layers, for example ``aarch64``,
> +      ``i586``, ``i686``, ``ppc64``, ``ppc64le``, or ``x86_64``.
> +

s/or ``x86_64``/and ``x86_64`` are :oe_git:`available in OpenEmbedded-Core </openembedded-core/tree/meta/conf/machine-sdk>`/ ?

Please triple check the link, I've just created it from memory.

> +      The variable defaults to :term:`BUILD_ARCH` so that SDKs are built for the
> +      build machine.

s/build machine/architecture of the build machine/ ?

Otherwise,

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks!
Quentin

Re: [docs] [PATCH 2/2] kickstart: update busybox note regarding PARTUUID

[Quentin Schulz]

Hi Ross,

On Mon, Nov 01, 2021 at 12:22:19PM +0000, Ross Burton wrote:
> As of oe-core c996cabf the default BusyBox configuration supports
> PARTUUID, so update the note to reflect this.
> 
> Signed-off-by: Ross Burton <ross.burton@arm.com>

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks,
Quentin

Re: [docs] [PATCH 2/2] kickstart: update busybox note regarding PARTUUID

[Michael Opdenacker]

Hi Ross,

On 11/1/21 1:22 PM, Ross Burton wrote:
> As of oe-core c996cabf the default BusyBox configuration supports
> PARTUUID, so update the note to reflect this.
>
> Signed-off-by: Ross Burton <ross.burton@arm.com>
> ---
>  documentation/ref-manual/kickstart.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
> index cac9f2f49..807f5e052 100644
> --- a/documentation/ref-manual/kickstart.rst
> +++ b/documentation/ref-manual/kickstart.rst
> @@ -54,8 +54,9 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or
>  .. note::
>  
>     The mount program must understand the PARTUUID syntax you use with
> -   ``--use-uuid`` and non-root *mountpoint*, including swap. The BusyBox
> -   versions of these application are currently excluded.
> +   ``--use-uuid`` and non-root *mountpoint*, including swap. The default
> +   configuration of BusyBox in OpenEmbedded supports this, but this may
> +   be disabled in custom configurations.
>  
>  Here is an example that uses "/" as the mountpoint. The command uses
>  ``--ondisk`` to force the partition onto the ``sdb`` disk::


Thanks for the updates.
However, this is out of sync with the messages in
scripts/lib/wic/help.py in OE core.

See https://lists.yoctoproject.org/g/docs/message/1520

How could we address the mismatch?
Could we update OE core instead and then the documentation? That would
be even better to include the text from the sources, but that I'm not
sure how to do this...

Cheers
Michael.

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

Re: [docs] [PATCH 2/2] kickstart: update busybox note regarding PARTUUID

[Michael Opdenacker]

Greetings,

On 11/2/21 3:54 PM, Michael Opdenacker wrote:
> Hi Ross,
>
> On 11/1/21 1:22 PM, Ross Burton wrote:
>> As of oe-core c996cabf the default BusyBox configuration supports
>> PARTUUID, so update the note to reflect this.
>>
>> Signed-off-by: Ross Burton <ross.burton@arm.com>
>> ---
>>  documentation/ref-manual/kickstart.rst | 5 +++--
>>  1 file changed, 3 insertions(+), 2 deletions(-)
>>
>> diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
>> index cac9f2f49..807f5e052 100644
>> --- a/documentation/ref-manual/kickstart.rst
>> +++ b/documentation/ref-manual/kickstart.rst
>> @@ -54,8 +54,9 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or
>>  .. note::
>>  
>>     The mount program must understand the PARTUUID syntax you use with
>> -   ``--use-uuid`` and non-root *mountpoint*, including swap. The BusyBox
>> -   versions of these application are currently excluded.
>> +   ``--use-uuid`` and non-root *mountpoint*, including swap. The default
>> +   configuration of BusyBox in OpenEmbedded supports this, but this may
>> +   be disabled in custom configurations.
>>  
>>  Here is an example that uses "/" as the mountpoint. The command uses
>>  ``--ondisk`` to force the partition onto the ``sdb`` disk::
>
> Thanks for the updates.
> However, this is out of sync with the messages in
> scripts/lib/wic/help.py in OE core.
>
> See https://lists.yoctoproject.org/g/docs/message/1520
>
> How could we address the mismatch?
> Could we update OE core instead and then the documentation? That would
> be even better to include the text from the sources, but that I'm not
> sure how to do this...

I merged the change into "master-next". That's better than before, but
the documentation is still out of date.

I'm keeping track of the issue, but I'd be interested in your thoughts
about how to keep the documentation in sync with the code changes.

Thanks in advance
Michael.

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