[scarthgap,styhead][PATCH 0/1] docs covering pick devtool ide-sdk fixes

[scarthgap,styhead][PATCH 0/1] docs covering pick devtool ide-sdk fixes

[Adrian Freihofer]

Related patch series is here:
https://lists.openembedded.org/g/openembedded-core/message/210279

Adrian Freihofer (1):
  sdk-manual: extensible.rst: update devtool ide-sdk

 documentation/sdk-manual/extensible.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

-- 
2.47.1

[scarthgap,styhead][PATCH 1/1] sdk-manual: extensible.rst: update devtool ide-sdk

[Adrian Freihofer]

From: Adrian Freihofer <adrian.freihofer@gmail.com>

Replace
  devtool ide-sdk --debug-build-config
by
  devtool modify --debug-build

This change was introduced with commit
https://git.yoctoproject.org/poky/commit/?id=1f7eb26c947dde14698ae6e2ab88f0637027f4cb

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/sdk-manual/extensible.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 3f6a754d8..f16d5a027 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -666,7 +666,8 @@ The extensible SDK supports two different development modes.
       IMAGE_INSTALL:append = " my-recipe"
 
    Assuming the BitBake environment is set up correctly and a workspace has
-   been created for the recipe using ``devtool modify my-recipe``, the
+   been created for the recipe using ``devtool modify my-recipe`` or probably
+   even better by using ``devtool modify my-recipe --debug-build``, the
    following command can create the SDK and the configuration for VSCode in
    the recipe workspace::
 
@@ -783,8 +784,8 @@ The extensible SDK supports two different development modes.
    .. code-block:: sh
 
       # Create the SDK
-      devtool modify cmake-example
-      devtool ide-sdk cmake-example core-image-minimal -c --debug-build-config --ide=none
+      devtool modify cmake-example --debug-build
+      devtool ide-sdk cmake-example core-image-minimal -c --ide=none
 
       # Install the firmware on a target device or start QEMU
       runqemu
-- 
2.47.1

Re: [scarthgap,styhead][PATCH 1/1] sdk-manual: extensible.rst: update devtool ide-sdk

[Antonin Godard]

Hi Adrian,

On Sun Jan 26, 2025 at 1:53 PM CET, Adrian Freihofer wrote:
> From: Adrian Freihofer <adrian.freihofer@gmail.com>
>
> Replace
>   devtool ide-sdk --debug-build-config
> by
>   devtool modify --debug-build
>
> This change was introduced with commit
> https://git.yoctoproject.org/poky/commit/?id=1f7eb26c947dde14698ae6e2ab88f0637027f4cb
>
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>  documentation/sdk-manual/extensible.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
> index 3f6a754d8..f16d5a027 100644
> --- a/documentation/sdk-manual/extensible.rst
> +++ b/documentation/sdk-manual/extensible.rst
> @@ -666,7 +666,8 @@ The extensible SDK supports two different development modes.
>        IMAGE_INSTALL:append = " my-recipe"
>  
>     Assuming the BitBake environment is set up correctly and a workspace has
> -   been created for the recipe using ``devtool modify my-recipe``, the
> +   been created for the recipe using ``devtool modify my-recipe`` or probably
> +   even better by using ``devtool modify my-recipe --debug-build``, the
>     following command can create the SDK and the configuration for VSCode in
>     the recipe workspace::
>  
> @@ -783,8 +784,8 @@ The extensible SDK supports two different development modes.
>     .. code-block:: sh
>  
>        # Create the SDK
> -      devtool modify cmake-example
> -      devtool ide-sdk cmake-example core-image-minimal -c --debug-build-config --ide=none
> +      devtool modify cmake-example --debug-build
> +      devtool ide-sdk cmake-example core-image-minimal -c --ide=none
>  
>        # Install the firmware on a target device or start QEMU
>        runqemu

I already backported "sdk-manual: extensible.rst: devtool ide-sdk improve" to
scarthgap-next and styhead-next.

But I don't think this one should be? The --debug-build opt is not backported on
styhead/scarthgap on oe-core (still using --debug-build-config).

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [scarthgap,styhead][PATCH 1/1] sdk-manual: extensible.rst: update devtool ide-sdk

[Adrian Freihofer]

Hi Antonin

It's a bit complicated to keep yocto-docs, oe-core and the bitbake
VSCode plugin consistent by sending patches to different mailing list
and different people. The related patch series for oe-core is here:
https://lists.openembedded.org/g/openembedded-core/message/210279.

There are multiple reasons, why I would like to update all the branches
to the same level:
 * Latest VSCode plugin does devtool modify --debug-build by default.
   With a poky without this option, the user has to take manual action.
 * It's a bug which should be fixed
 * It's without risk for breaking something, it's a trivial change.

So probably yocto-docs needs to wait until oe-core decides and then
follow. Is this possible?

Thank you.
Adrian

Re: [scarthgap,styhead][PATCH 1/1] sdk-manual: extensible.rst: update devtool ide-sdk

[Antonin Godard]

Hi Adrian,

On Mon Jan 27, 2025 at 11:18 AM CET, Adrian Freihofer wrote:
> Hi Antonin
>
> It's a bit complicated to keep yocto-docs, oe-core and the bitbake
> VSCode plugin consistent by sending patches to different mailing list
> and different people. The related patch series for oe-core is here:
> https://lists.openembedded.org/g/openembedded-core/message/210279.
>
> There are multiple reasons, why I would like to update all the branches
> to the same level:
>  * Latest VSCode plugin does devtool modify --debug-build by default.
>    With a poky without this option, the user has to take manual action.
>  * It's a bug which should be fixed
>  * It's without risk for breaking something, it's a trivial change.
>
> So probably yocto-docs needs to wait until oe-core decides and then
> follow. Is this possible?

Sorry, I hadn't noticed that you also sent backports on oe-core. I'll try to
monitor this and make sure the doc patch also gets backported. Feel free to
bounce it if I forget. ;)

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com