From patchwork Tue Aug 22 19:20:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Adrian Freihofer X-Patchwork-Id: 29277 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 02853EE49AE for ; Tue, 22 Aug 2023 19:23:56 +0000 (UTC) Received: from mail-ej1-f45.google.com (mail-ej1-f45.google.com [209.85.218.45]) by mx.groups.io with SMTP id smtpd.web10.5243.1692732230526100067 for ; Tue, 22 Aug 2023 12:23:50 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20221208 header.b=eipQl4fb; spf=pass (domain: gmail.com, ip: 209.85.218.45, mailfrom: adrian.freihofer@gmail.com) Received: by mail-ej1-f45.google.com with SMTP id a640c23a62f3a-99c3c8adb27so628403966b.1 for ; Tue, 22 Aug 2023 12:23:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1692732229; x=1693337029; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=AoenDSfxEhrJSXJzwNF0qUZi4ZdzROlnUR735GqJdd4=; b=eipQl4fbEUApdw2WQSWhdsNoS+pHHxGYc4k1yF/Xzj9gZnc46lnvySl96cmVG6a2Sm i1gVrQcjg7M0/JWwe3YWDVCMpOXXDwtv8Emd002uGyWgthmWlcxCuvBXJv9Bz9+rkimR Uv46dNqavdYf8XnMxMosVqu7qxC+tV2J0umTZkYA4tFwUmkyudN95wvNaZzk32OXbjGV w+ClEO86PBaDIlnruujGe9CdMTN1WhoHLlSclvqbzDyJqI7LT4b9tsEdnbBiVKFrIfCz rpbku2soXVSBRIoGddPC8ipUDo3HNlv4wXG42wBNBZbAwROu7otJwxQ6j0RWOU09pY4j X5TQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692732229; x=1693337029; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=AoenDSfxEhrJSXJzwNF0qUZi4ZdzROlnUR735GqJdd4=; b=B+ip0z3S6U3FvOBbos6lYSzLFxeCab/WUR9/pm1wlMLaqbslonUuQoYyqrajPs865S gPjIzR0FmxjiDHwbdafnDFJ5aLZFSrJH2Nr+kWusMgxU0iBaZO3h0OkbFKBWF0znDz65 /QbEWQ75Rbu903ic1siu1+0jXzcVI64LDADolrU/5LLccC7aLG+zdxB29d8wp00Vuno3 BpCVBkuiELAoO4jKmt8Uf/CKKFJBGV25zrHjoSvY/XhaUZAOWgMI6zB5wYJgcb7WWUOV +B8wJbG3eESNRzCoaoGFaF3B1+lf7YYJGNf9MfSd9AdHuvMRfK3mCGtbfdhBW7pNTUJH weFw== X-Gm-Message-State: AOJu0YxpQi+KWZ68em0zU6lg9pXRf1bHbxxcHHHkGxKUyLphHE7XC2Wr AR2CcyjYdaHRckGBJ0KO482veBJUJW8= X-Google-Smtp-Source: AGHT+IFOfumCFlVWBJQNRdsAQ2Q5zk62m7OiKCnyRlsSh4GdOYeb20ftPl4SKuR4mA3N7Jbf1Q9jrQ== X-Received: by 2002:a17:906:291:b0:9a1:c357:c743 with SMTP id 17-20020a170906029100b009a1c357c743mr1229578ejf.52.1692732228478; Tue, 22 Aug 2023 12:23:48 -0700 (PDT) Received: from t14s-af.fritz.box ([2a02:169:59a6:0:dcf2:2f65:9442:83f]) by smtp.gmail.com with ESMTPSA id g24-20020a1709063b1800b0098f99048053sm8744041ejf.148.2023.08.22.12.23.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 22 Aug 2023 12:23:48 -0700 (PDT) From: Adrian Freihofer X-Google-Original-From: Adrian Freihofer To: openembedded-core@lists.openembedded.org Cc: Adrian Freihofer Subject: [PATCH v2 13/13] docs: cover devtool ide Date: Tue, 22 Aug 2023 21:20:19 +0200 Message-ID: <20230822192300.3235896-14-adrian.freihofer@siemens.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230822192300.3235896-1-adrian.freihofer@siemens.com> References: <20230822192300.3235896-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 22 Aug 2023 19:23:56 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/186536 Signed-off-by: Adrian Freihofer --- documentation/sdk-manual/extensible.rst | 97 ++++++++++++++++++++++++- 1 file changed, 96 insertions(+), 1 deletion(-) diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 9e08e57a4e7..d05d4e36aa7 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst @@ -237,7 +237,7 @@ all the commands. devtool quick reference. -Three ``devtool`` subcommands provide entry-points into +Four ``devtool`` subcommands provide entry-points into development: - *devtool add*: Assists in adding new software to be built. @@ -245,6 +245,8 @@ development: - *devtool modify*: Sets up an environment to enable you to modify the source of an existing component. +- *devtool ide*: Generates a configuration for an IDE. + - *devtool upgrade*: Updates an existing recipe so that you can build it for an updated set of source files. @@ -632,6 +634,99 @@ command: proceed with your work. If you do use this command, realize that the source tree is preserved. +Use ``devtool ide`` to generate an configuration for the IDE +------------------------------------------------------------ + +``devtool ide`` automatically configures the IDE for cross-compiling and remote debugging. +The IDE is configured to call for example cmake directly. This has several advantages. +First of all it is much faster than using e.g. ``devtool build``. But it also allows to +use the very good integration of build tools like cmake or gdb with VSCode directly. + +Two different use cases are supported: + +- Generate the IDE configuration for a workspace created by ``devtool modify``. + +- Generate the IDE configuration for using a cross-toolchain as provided by + ``bitbake meta-ide-support build-sysroots``. + +Assuming the development environment is set up correctly and a workspace has been created +for the recipe using ``devtool modify recipe``, the following command can create the +configuration for VSCode in the recipe workspace: + + $ devtool ide recipe core-image-minimal --target root@192.168.7.2 + +What this command does exactly depends on the recipe or the build tool used by the recipe. +Currently, only CMake and Meson are supported natively. + +For a recipe which inherits cmake it does: + +- Prepare the SDK by calling bitbake core-image-minimal, gdb-cross, qemu-native... + +- Generate a cmake-preset with configures cmake to use exactly the same environent and + the same cmake-cache configuration as used by ``bitbake recipe``. The cmake-preset referres + to the per-recipe-sysroot of the recipe. + + Currently Configure, Build and Test presets are supported. Test presets execute the test + binaries with Qemu. + +- Generates a helper script to handle the do_install with pseudo + +- Generates some helper scripts to start the gdbserver on the target device + +- Generates the ``.vscode`` folder containing the following files: + + - c_ccp_properties.json: configure the code navigation + + - extensions.json: Recommend the extensions which are used. + + - launch.json: Provide a configuration for remote debugging with gdb-cross and gdbserver. + The debug-symbols are searched in the build-folder, the per-recipe-sysroot and the rootfs-dbg + folder which is provided by the image. + + - settings.json: confgure the indexer to ignore the build folders + + - tasks.json: Provide some helpers for running + + - do_install and ``devtool deploy-target`` + + - start the gdbserver via ssh + +For a recipe which inherits meson a similar configuration is generated. +Because there is nothing like a meson-preset a wrapper script for meson is generated. + +For some special recipes and use cases a per-recipe-sysroot based SDK is not suitable. +Therefore devtool ide also supports setting up the shared sysroots environment and generating +a IDE configurations referring to the shared sysroots. Recipes leading to a shared sysroot +are for example meta-ide-support or shared-sysroots. Also passing none as a recipe name leads +to a shared sysroot SDK. + + $ devtool ide none core-image-minimal + +In case of a shared sysroot SDK the configuration which gets generated for VSCode exposes the +cross-tool-chain as a cmake-kit. If a cmake project is loaded into VSCode the cross-toolchain +can be selected for compiling. + +The default IDE is VSCode. Some hints about using VSCode: + +- 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. + A cmake kit might be activated by ``Ctrl + Shift + p``, type cmake quick start, + if not preset file is in the wokspace. + +- To work with meson press ``Ctrl + Shift + p``, type meson. + This will show some possible commands like compiling or executing the unit tests. + +- For the deployment to the target device, just press ``Ctrl + Shift + p``, type task. + Select the install & deploy task. + +- For remote debugging, switch to the debugging view by pressing the play button with the bug on the left side. + This will provide a green play button with a drop-down list where a debug configuration can be selected. + After selecting one of the generated configurations, press the play button. + +Additionally ``--ide=none`` is supported. +With the none IDE some generic configurations files like .gdbinit files and some helper scripts +are generated. + Use ``devtool upgrade`` to Create a Version of the Recipe that Supports a Newer Version of the Software -------------------------------------------------------------------------------------------------------