summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/devtool-reference.rst
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-10-17 16:15:30 +0200
committerSteve Sakoman <steve@sakoman.com>2024-11-11 06:19:19 -0800
commitf4eb87b28a1fbdb2e3d37ca255220771eb223061 (patch)
tree81ab155b85c679bb77de01e6f9a13acb1528aca8 /documentation/ref-manual/devtool-reference.rst
parent4a9e116da8b3dc2692c7e96d272fd2c839ffde49 (diff)
downloadpoky-f4eb87b28a1fbdb2e3d37ca255220771eb223061.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. Cherry pick: Remove devtool ide-sdk from commit, this command was not backported to kirkstone. (From yocto-docs rev: 8a5111c406be9c4bf1cc78a34dd2174a227ca79c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6238adae1b072c9e09c558038d397dfac6ec109f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/ref-manual/devtool-reference.rst')
-rw-r--r--documentation/ref-manual/devtool-reference.rst32
1 files changed, 31 insertions, 1 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 70b36127eb..a50789171a 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -50,7 +50,6 @@ has a number of sub-commands for each function. You can run
50 search Search available recipes 50 search Search available recipes
51 Working on a recipe in the workspace: 51 Working on a recipe in the workspace:
52 build Build a recipe 52 build Build a recipe
53 ide-sdk Setup the SDK and configure the IDE
54 rename Rename a recipe file in the workspace 53 rename Rename a recipe file in the workspace
55 edit-recipe Edit a recipe file 54 edit-recipe Edit a recipe file
56 find-recipe Find a recipe file 55 find-recipe Find a recipe file
@@ -461,6 +460,20 @@ Here is an example that resets the workspace directory that contains the
461 NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually 460 NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually
462 $ 461 $
463 462
463.. _devtool-finish-working-on-a-recipe:
464
465Finish Working on a Recipe
466==========================
467
468Use the ``devtool finish`` command to push any committed changes to the
469specified recipe in the specified layer and remove it from your workspace.
470
471This is roughly equivalent to the ``devtool update-recipe`` command followed by
472the ``devtool reset`` command. The changes must have been committed to the git
473repository created by ``devtool``. Here is an example::
474
475 $ devtool finish recipe /path/to/custom/layer
476
464.. _devtool-building-your-recipe: 477.. _devtool-building-your-recipe:
465 478
466Building Your Recipe 479Building Your Recipe
@@ -613,3 +626,20 @@ a match.
613 626
614When you use the ``devtool search`` command, you must supply a keyword. 627When you use the ``devtool search`` command, you must supply a keyword.
615The command uses the keyword when searching for a match. 628The command uses the keyword when searching for a match.
629
630Alternatively, the ``devtool find-recipe`` command can be used to search for
631recipe files instead of recipe names. Likewise, you must supply a keyword.
632
633.. _devtool-get-the-configure-script-help:
634
635Get Information on Recipe Configuration Scripts
636===============================================
637
638Use the ``devtool configure-help`` command to get help on the configuration
639script options for a given recipe. You must supply the recipe name to the
640command. For example, it shows the output of ``./configure --help`` for
641:ref:`autotools <ref-classes-autotools>`-based recipes.
642
643The ``configure-help`` command will also display the configuration options
644currently in use, including the ones passed through the :term:`EXTRA_OECONF`
645variable.