Re: [docs] [PATCH] sdk-manual: extensible.rst: devtool ide-sdk improve

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi Adrian,

On Tue Jan 14, 2025 at 10:25 PM CET, Adrian Freihofer via lists.yoctoproject.org wrote:
> The devtool ide-sdk section is reformulated to be independent of the
> eSDK installer. In fact, ide-sdk does not even support the execution
> of an installer-based setup.

Just so that others reading this know: the devtool documentation will be
moved to its dedicated section in another patch series (WIP).

> It should be clarified that devtool ide-sdk starts the SDK directly
> from the bitbake environment. It is therefore an alternative to
> bitbake -c populate_sdk_ext and installing an SDK installer.
>
> A warning is added that explains some workarounds for some nasty
> behavior of VSCode when running it in a bitbake environment.
>
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>  documentation/sdk-manual/extensible.rst | 192 +++++++++++++++++-------
>  1 file changed, 137 insertions(+), 55 deletions(-)
>
> diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
> index 1cb1bb47c2c..73ce509c3bb 100644
> --- a/documentation/sdk-manual/extensible.rst
> +++ b/documentation/sdk-manual/extensible.rst
> @@ -622,28 +622,85 @@ command:
>        decide you do not want to proceed with your work. If you do use this
>        command, realize that the source tree is preserved.
>  
> -``devtool ide-sdk`` configures IDEs for the extensible SDK
> -----------------------------------------------------------
> +``devtool ide-sdk`` configures IDEs and bootstraps SDKs
> +-------------------------------------------------------
>  
> -``devtool ide-sdk`` automatically configures IDEs to use the extensible SDK.
> -To make sure that all parts of the extensible SDK required by the generated
> -IDE configuration are available, ``devtool ide-sdk`` uses BitBake in the
> -background to bootstrap the extensible SDK.
> +``devtool ide-sdk`` is supposed to configure IDEs for working on the source

How about "The ``devtool ide-sdk`` command can provide an IDE configuration
for..."?

> +code of one or more recipes.
> +Depending on the programming language, and the build system used by the recipe,
> +the tools required for cross-development and remote debugging are different.

Formatting wise, I would add "For example:" here, followed by a list:

"""
-  A C/C++ project...
-  A Python project...
...
"""

> +A C/C++ project usually uses CMake or Meson.
> +A Python project uses setuptools or one of its successors.
> +A Rust project uses Cargo.
> +Also, the IDE plugins needed for the integration of a build system with the
> +IDE and the corresponding settings are usually specific to these buildsystems.

s/buildsystems/build systems/

> +To hide all these details from the user, ``devtool ide-sdk`` does two things:
> +
> +-  It generates any kind of SDK needed for cross-development and remote
> +   debugging of the specified recipes.
> +
> +-  It generates the configuration for the IDE (and the IDE plugins) for using
> +   the cross-toolchain and remote debugging tools provided by the SDK directly
> +   from the IDE.
> +
> +For supported build systems the configurations generated by ``devtool ide-sdk``
> +combine the advantages of the ``devtool modify`` based workflow
> +(see :ref:`using_devtool`) with the advantages of the simple Environment Setup
> +script based workflow (see :ref:`running_the_ext_sdk_env`) provided by Yocto's
> +SDK or eSDK:
> +
> +-  The source code of the recipe is in the workspace created by
> +   ``devtool modify`` or ``devtool add``.
> +   Using ``devtool build``, ``devtool build-image``,
> +   ``devtool deploy-target`` or ``bitbake`` is possible.
> +   Also ``devtool ide-sdk`` can be used to update the SDK and the IDE
> +   configuration at any time.
> +
> +-  ``devtool ide-sdk`` aims to support multiple programming languages and
> +   multiple IDEs natively. "Natively" means that the IDE is configured to call
> +   the build tool (e.g. CMake or Meson) directly. This has several advantages.
> +   First of all, it is usually much faster to call for example ``cmake`` than
> +   ``devtool build``.
> +   It also allows to benefit from the very good integration that IDEs like
> +   VSCode offer for tools like CMAke or GDB.

s/CMAke/CMake/

> +   
> +   However, supporting many programming languages and multiple
> +   IDEs is quite an elaborate and constantly evolving thing. Support for IDEs
> +   is therefore implemented as plugins. Plugins can also be provided by
> +   optional layers.
>  
> -The extensible SDK supports two different development modes.
> -``devtool ide-sdk`` supports both of them:
> +So much about the introduction to the default mode of ``devtool sdk-ide`` which
> +is called the "modified" mode because it uses the workspace created by
> +``devtool modify`` and the per recipe sysroots of bitbake.

Some comments:

*  When "bitbake" is not meant as a command but as the project, you should use the
   "BitBake" instead of "bitbake" (several occurences here)

* Likewise, "devtool" occurences should be replaced by "``devtool``"

*  s/sysroots/:term:`Sysroots <Sysroot>`/

> +
> +For some recipes and use cases, this default behavior of ``devtool ide-sdk``
> +with full devtool and bitbake integration might not be suitable.
> +To offer full feature parity with the SDK and the eSDK, ``devtool ide-sdk`` has
> +a second mode called "shared" mode.
> +If ``devtool ide-sdk`` is called with the ``--mode=shared`` option, it
> +bootstraps an SDK directly from the bitbake environment, which offers the same
> +Environment Setup script as described in :ref:`running_the_ext_sdk_env`.
> +In addition to the (e)SDK installer-based setup, the IDE gets configured
> +to use the shared sysroots and the tools from the SDK.
> +``devtool ide-sdk --mode=shared`` is basically a wrapper for the setup of the
> +extensible SDK as described in :ref:`setting_up_ext_sdk_in_build`.
> +
> +The use of ``devtool ide-sdk`` is an alternative to using one of the SDK
> +installers.
> +``devtool ide-sdk`` allows the creation of SDKs that offer all the
> +functionality of the SDK and the eSDK installers. Compared to the installers,
> +however, the SDK created with ``devtool ide-sdk`` is much more flexible.
> +For example, it is very easy to change the :term:`MACHINE` in the
> +``local.conf`` file, update the layer meta data and then regenerate the SDK.
> +
> +Let's take a look at an example of how to use ``devtool ide-sdk`` in each of
> +the two modes:
>  
>  #. *Modified mode*:
>  
> -   By default ``devtool ide-sdk`` generates IDE configurations for recipes in
> -   workspaces created by ``devtool modify`` or ``devtool add`` as described in
> -   :ref:`using_devtool`.  This mode creates IDE configurations with support for
> -   advanced features, such as deploying the binaries to the remote target
> -   device and performing remote debugging sessions. The generated IDE
> -   configurations use the per recipe sysroots as Bitbake does internally.
> -
> -   In order to use the tool, a few settings are needed. As a starting example,
> -   the following lines of code can be added to the ``local.conf`` file::
> +   In order to use the ``devtool ide-sdk``, a few settings are needed. As a
> +   starting example, the following lines of code can be added to the
> +   ``local.conf`` file::
>  
>        # Build the companion debug file system
>        IMAGE_GEN_DEBUGFS = "1"
> @@ -675,9 +732,10 @@ The extensible SDK supports two different development modes.
>  
>        $ devtool ide-sdk my-recipe core-image-minimal --target root@192.168.7.2
>  
> -   The command requires an image recipe (``core-image-minimal`` for this example)
> -   that is used to create the SDK. This firmware image should also be installed
> -   on the target device.  It is possible to pass multiple package recipes.
> +   The command requires an image recipe (``core-image-minimal`` for this
> +   example) that is used to create the SDK.
> +   This firmware image should also be installed on the target device.
> +   It is possible to pass multiple package recipes.

How? Like this?

$ devtool ide-sdk my-recipe1 my-recipe2 core-image-minimal --target root@192.168.7.2

Maybe add an example

>     ``devtool ide-sdk`` tries to create an IDE configuration for all package
>     recipes.
>  
> @@ -702,23 +760,53 @@ The extensible SDK supports two different development modes.
>        running on the target device, it is essential that the image built by
>        ``devtool ide-sdk`` is running on the target device.
>  
> -   ``devtool ide-sdk`` aims to support multiple programming languages and
> -   multiple IDEs natively. "Natively" means that the IDE is configured to call
> -   the build tool (e.g. CMake or Meson) directly. This has several advantages.
> -   First of all, it is much faster than ``devtool build``, but it also allows
> -   to use the very good integration of tools like CMake or GDB in VSCode and
> -   other IDEs. However, supporting many programming languages and multiple
> -   IDEs is quite an elaborate and constantly evolving thing. Support for IDEs
> -   is therefore implemented as plugins. Plugins can also be provided by
> -   optional layers.
> -
>     The default IDE is VSCode. Some hints about using VSCode:
>  
> -   -  To work on the source code of a recipe an instance of VSCode is started in
> -      the recipe's workspace. Example::
> +   -  VSCode can be used to work on the bitbake recipes as well as for the work
> +      on the application source code. Usually there is one instance of VSCode

I would rephrase to "VSCode can be used to work on the BitBake recipes or the
application source code".

> +      running in the folder where the bitbake recipes are. This instance has
> +      the
> +      `Yocto Project BitBake plugin <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`_
> +      running.
> +
> +      .. warning::
> +
> +         Some VSCode plugins (Python, BitBake and others) need a reasonable
> +         configuration to work as expected. Otherwise, some plugins try to
> +         index the build directory of BitBake, which keeps your system quite
> +         busy until an out of memory exception stops this nonsense.
> +         Other plugins, such as the BitBake plugin, do not behave as expected.
> +
> +         To work around such issues, the ``oe-init-build-env`` script creates
> +         an initial ``.vscode/settings.json`` file if ``code`` can be found
> +         and the ``.vscode`` folder does not yet exist.
> +         It is best to run ``oe-init-build-env`` once before starting VSCode.
> +         An alternative approach is to use a build folder outside the layers,
> +         e.g. ``oe-init-build-env ../build``.
> +
> +      The BitBake plugin also offers to create devtool workspaces and run
> +      ``devtool ide-sdk`` with a few mouse clicks.
> +      Of course, issuing commands in the terminal works as well.
> +
> +   -  To work on the source code of a recipe another instance of VSCode is
> +      started in the recipe's workspace. Example::
>  
>           code build/workspace/sources/my-recipe
>  
> +      This instance of VSCode uses plugins that are useful for the development
> +      of the application. ``devtool ide-sdk`` generates the necessary
> +      ``extensions.json``, ``settings.json``, ``tasks.json``and ``launch.json``
> +      configuration files for all the involved plugins.
> +
> +      When the workspace folder is opened in VSCode for the first time, a

You mean the source code folder present in the workspace?

> +      pop-up message recommends installing the required plugins.
> +      After accepting the installation of the plugins, working with the source
> +      code or some debugging tasks should work as usual with VSCode.
> +
> +      Starting the VSCode instances in the recipe workspace folders can also be
> +      done by a mouse click on the recipe workspaces in the first VSCode
> +      instance.
> +
>     -  To work with CMake press ``Ctrl + Shift + p``, type ``cmake``. This will
>        show some possible commands like selecting a CMake preset, compiling or
>        running CTest.
> @@ -731,10 +819,9 @@ The extensible SDK supports two different development modes.
>        show some possible commands like compiling or executing the unit tests.
>  
>        A note on running cross-compiled unit tests on the host: Meson enables
> -      support for QEMU user-mode by default. It is expected that the execution
> -      of the unit tests from the IDE will work easily without any additional
> -      steps, provided that the code is suitable for execution on the host
> -      machine.
> +      support for QEMU user mode by default. It is expected that the execution
> +      of the unit tests from the IDE will work without any additional steps,
> +      given that the code is suitable for the execution on the host machine.
>
>     -  For the deployment to the target device, just press ``Ctrl + Shift + p``,
>        type ``task``.  Select ``install && deploy-target``.
> @@ -745,23 +832,23 @@ The extensible SDK supports two different development modes.
>        selected.  After selecting one of the generated configurations, press the
>        "play" button.
>  
> -      Starting a remote debugging session automatically initiates the deployment
> -      to the target device. If this is not desired, the
> +      Starting a remote debugging session automatically initiates the
> +      deployment to the target device. If this is not desired, the
>        ``"dependsOn": ["install && deploy-target...]`` parameter of the tasks
>        with ``"label": "gdbserver start...`` can be removed from the
>        ``tasks.json`` file.
>  
> -      VSCode supports GDB with many different setups and configurations for many
> -      different use cases.  However, most of these setups have some limitations
> -      when it comes to cross-development, support only a few target
> +      VSCode supports GDB with many different setups and configurations for
> +      many different use cases.  However, most of these setups have some
> +      limitations when it comes to cross-development, support only a few target
>        architectures or require a high performance target device. Therefore
>        ``devtool ide-sdk`` supports the classic, generic setup with GDB on the
>        development host and gdbserver on the target device.
>  
>        Roughly summarized, this means:
>  
> -      -  The binaries are copied via SSH to the remote target device by a script
> -         referred by ``tasks.json``.
> +      -  The binaries are copied via SSH to the remote target device by a
> +         script referred by ``tasks.json``.
>  
>        -  gdbserver is started on the remote target device via SSH by a script
>           referred by ``tasks.json``.
> @@ -863,16 +950,9 @@ The extensible SDK supports two different development modes.
>  
>  #. *Shared sysroots mode*
>  
> -   For some recipes and use cases a per-recipe sysroot based SDK is not
> -   suitable.  Optionally ``devtool ide-sdk`` configures the IDE to use the
> -   toolchain provided by the extensible SDK as described in
> -   :ref:`running_the_ext_sdk_env`. ``devtool ide-sdk --mode=shared`` is
> -   basically a wrapper for the setup of the extensible SDK as described in
> -   :ref:`setting_up_ext_sdk_in_build`. The IDE gets a configuration to use the
> -   shared sysroots.
> -
> -   Creating a SDK with shared sysroots that contains all the dependencies needed
> -   to work with ``my-recipe`` is possible with the following example command::
> +   Creating a SDK with shared sysroots that contains all the dependencies

I believe "an SDK" is more often used in the docs.

> +   needed to work with ``my-recipe`` is possible with the following example
> +   command::
>  
>        $ devtool ide-sdk --mode=shared my-recipe
>  
> @@ -886,12 +966,14 @@ The extensible SDK supports two different development modes.
>        echo "project(foo VERSION 1.0)" > kit-test/CMakeLists.txt
>        code kit-test
>  
> -   If there is a CMake project in the workspace, cross-compilation is supported:
> +   If there is a CMake project in the workspace, cross-compilation is
> +   supported:
>  
>     - Press ``Ctrl + Shift + P``, type ``CMake: Scan for Kits``
>     - Press ``Ctrl + Shift + P``, type ``CMake: Select a Kit``
>  
> -   Finally most of the features provided by CMake and the IDE should be available.
> +   Finally most of the features provided by CMake and the IDE should be
> +   available.
>  
>     Other IDEs than VSCode are supported as well. However,
>     ``devtool ide-sdk --mode=shared --ide=none my-recipe`` is currently

Thanks for the patch,
Antonin

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