summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-10-17 16:15:30 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-10-31 14:24:24 +0000
commitf16dc3705a84879eda57a42ceb4ab3e510f84837 (patch)
tree725f9d6e13a924cf13aba804765f7e56d372d007
parent67cc5cf96843e27170194e91ec861a7d0d0ad3b4 (diff)
downloadpoky-f16dc3705a84879eda57a42ceb4ab3e510f84837.tar.gz
ref-manual: devtool-reference: document missing commands
Give a brief description for important commands that made it into devtool or that were missing from this quick reference document. (From yocto-docs rev: 6238adae1b072c9e09c558038d397dfac6ec109f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/devtool-reference.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 9c36195c5a..d74d5c29ae 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -463,6 +463,20 @@ Here is an example that resets the workspace directory that contains the
463 NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually 463 NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually
464 $ 464 $
465 465
466.. _devtool-finish-working-on-a-recipe:
467
468Finish Working on a Recipe
469==========================
470
471Use the ``devtool finish`` command to push any committed changes to the
472specified recipe in the specified layer and remove it from your workspace.
473
474This is roughly equivalent to the ``devtool update-recipe`` command followed by
475the ``devtool reset`` command. The changes must have been committed to the git
476repository created by ``devtool``. Here is an example::
477
478 $ devtool finish recipe /path/to/custom/layer
479
466.. _devtool-building-your-recipe: 480.. _devtool-building-your-recipe:
467 481
468Building Your Recipe 482Building Your Recipe
@@ -614,3 +628,43 @@ a match.
614 628
615When you use the ``devtool search`` command, you must supply a keyword. 629When you use the ``devtool search`` command, you must supply a keyword.
616The command uses the keyword when searching for a match. 630The command uses the keyword when searching for a match.
631
632Alternatively, the ``devtool find-recipe`` command can be used to search for
633recipe files instead of recipe names. Likewise, you must supply a keyword.
634
635.. _devtool-get-the-configure-script-help:
636
637Get Information on Recipe Configuration Scripts
638===============================================
639
640Use the ``devtool configure-help`` command to get help on the configuration
641script options for a given recipe. You must supply the recipe name to the
642command. For example, it shows the output of ``./configure --help`` for
643:ref:`autotools <ref-classes-autotools>`-based recipes.
644
645The ``configure-help`` command will also display the configuration options
646currently in use, including the ones passed through the :term:`EXTRA_OECONF`
647variable.
648
649.. _devtool-generate-an-ide-configuration-for-a-recipe:
650
651Generate an IDE Configuration for a Recipe
652==========================================
653
654The ``devtool ide-sdk`` automatically creates an IDE configuration and SDK to
655work on a given recipe. Depending on the ``--mode`` parameter, different types
656of SDKs are generated:
657
658- ``modified`` mode: this creates an SDK and generates an IDE configuration in
659 the workspace directory.
660
661- ``shared`` mode: this creates a cross-compiling toolchain and the
662 corresponding shared sysroot directories of the supplied recipe(s).
663
664The ``--target`` option can be used to specify a ``username@hostname`` string
665and create a remote debugging configuration for the recipe. Similarly to
666``devtool deploy-target``, it requires an SSH server running on the target.
667
668For further details on the ``devtool ide-sdk`` command, see the
669":doc:`/sdk-manual/extensible`" chapter in the Yocto Project Application
670Development and the Extensible Software Development Kit (eSDK) manual.