Lines Matching +full:reset +full:- +full:source
1 .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
7 The ``devtool`` command-line tool provides a number of features that
14 SDK, see the ":doc:`/sdk-manual/extensible`" chapter in the Yocto
18 .. _devtool-getting-help:
24 has a number of sub-commands for each function. You can run
25 ``devtool --help`` to see all the commands::
27 $ devtool -h
29 …usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] [--color COLOR] [-h] <subcommand>…
34 --basepath BASEPATH Base directory of SDK / build directory
35 --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it from the metadata
36 -d, --debug Enable debug output
37 -q, --quiet Print only errors
38 --color COLOR Colorize output (where COLOR is auto, always, never)
39 -h, --help show this help message and exit
44 modify Modify the source for an existing recipe
48 latest-version Report the latest version of an existing recipe
49 check-upgrade-status Report upgradability for multiple (or all) recipes
54 edit-recipe Edit a recipe file
55 find-recipe Find a recipe file
56 configure-help Get help on configure script options
57 update-recipe Apply changes from external source tree to recipe
58 reset Remove a recipe from your workspace
61 deploy-target Deploy recipe output files to live target machine
62 undeploy-target Undeploy recipe output files in live target machine
63 build-image Build image including workspace recipe packages
65 create-workspace Set up workspace in an alternative location
66 extract Extract the source for an existing recipe
67 sync Synchronize the source tree for an existing recipe
68 menuconfig Alter build-time configuration for a recipe
72 selftest-reverse Reverse value (for selftest)
77 Use devtool <subcommand> --help to get help on a specific command
81 using ``--help``::
83 $ devtool add --help
85 …-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev] [--version VERSION] [--no-git] [--srcre…
86 [--provides PROVIDES]
89 … the workspace to build a specified source tree. Can optionally fetch a remote URI and unpack it t…
92 … Name for new recipe to add (just name - no version, path or extension). If not specified, will a…
93 …srctree Path to external source tree. If not specified, a subdirectory of /media/bui…
94 fetchuri Fetch the specified URI and extract it to create the source tree
97 -h, --help show this help message and exit
98 --same-dir, -s Build in same directory as source
99 --no-same-dir Force build in a separate build directory
100 …--fetch URI, -f URI Fetch the specified URI and extract it to create the source tree (deprecated…
101 --npm-dev For npm, also fetch devDependencies
102 --version VERSION, -V VERSION
104 --no-git, -g If fetching source, do not set up source tree as a git repository
105 --srcrev SRCREV, -S SRCREV
106 … Source revision to fetch if fetching from an SCM such as git (default latest)
107 …--autorev, -a When fetching from a git repository, set SRCREV in the recipe to a floating …
108 --srcbranch SRCBRANCH, -B SRCBRANCH
109 … Branch in source repository if fetching from an SCM such as git (default master)
110 …--binary, -b Treat the source tree as something that should be installed verbatim (no com…
111 …--also-native Also add native variant (i.e. support building recipe for the build host as …
112 --src-subdir SUBDIR Specify subdirectory within source tree to use
113 … --mirrors Enable PREMIRRORS and MIRRORS for source tree fetching (disable by default).
114 --provides PROVIDES, -p PROVIDES
117 .. _devtool-the-workspace-layer-structure:
128 .. image:: figures/build-workspace-directory.png
132 .. code-block:: none
134 attic - A directory created if devtool believes it must preserve
135 anything when you run "devtool reset". For example, if you
137 run "devtool reset", devtool takes notice that the file has
141 README - Provides information on what is in workspace layer and how to
144 .devtool_md5 - A checksum file used by devtool.
146 appends - A directory that contains *.bbappend files, which point to
147 external source.
149 conf - A configuration directory that contains the layer.conf file.
151 recipes - A directory containing recipes. This directory contains a
154 within that sub-directory.
156 sources - A directory containing a working copy of the source files used
158 as the location of the source tree when you do not provide a
159 source tree path. This directory contains a folder for each
160 set of source files matched to a corresponding recipe.
162 .. _devtool-adding-a-new-recipe-to-the-workspace:
168 layer. The recipe you add should not exist - ``devtool`` creates it for
169 you. The source files the recipe uses should exist in an external area.
172 a workspace layer the tool creates. The source code built by the recipes
179 ":ref:`devtool-the-workspace-layer-structure`" section.
182 to add the recipe, append files, and source files into the existing
184 external source tree.
193 ":ref:`ref-manual/devtool-reference:deploying your software on the target machine`"
198 specify a source revision by branch, tag, or commit hash. You can
201 - To specify a source branch, use the ``--srcbranch`` option::
203 $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson
208 - To specify a specific tag or commit hash, use the ``--srcrev``
211 $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson
212 $ devtool add --srcrev some_commit_hash /home/user/sources/jackson
221 built, use the options ``--autorev`` or ``-a``.
223 .. _devtool-extracting-the-source-for-an-existing-recipe:
225 Extracting the Source for an Existing Recipe
228 Use the ``devtool extract`` command to extract the source for an
231 supply the directory to which you want the source extracted.
234 branch into which you can checkout the source and whether or not to keep
237 .. _devtool-synchronizing-a-recipes-extracted-source-tree:
239 Synchronizing a Recipe's Extracted Source Tree
243 source tree for an existing recipe. When you use this command, you must
246 source extracted.
249 branch into which you can checkout the source and whether or not to keep
252 .. _devtool-modifying-a-recipe:
257 Use the ``devtool modify`` command to begin modifying the source of an
259 :ref:`add <devtool-adding-a-new-recipe-to-the-workspace>` command
263 The ``devtool modify`` command extracts the source for a recipe, sets it
264 up as a Git repository if the source had not already been fetched from
267 checkout the source files::
272 :term:`SRC_URI` statement to locate the upstream source,
273 extracts the source into the default sources location in the workspace.
276 .. _devtool-edit-an-existing-recipe:
281 Use the ``devtool edit-recipe`` command to run the default editor, which
284 When you use the ``devtool edit-recipe`` command, you must supply the
289 .. _devtool-updating-a-recipe:
294 Use the ``devtool update-recipe`` command to update your recipe with
295 patches that reflect changes you make to the source files. For example,
297 :ref:`devtool modify <devtool-modifying-a-recipe>` command to extract
303 ``devtool update-recipe`` to create the patches and update the recipe::
305 $ devtool update-recipe recipe
307 If you run the ``devtool update-recipe``
312 can use the ``-a`` or ``--append`` option with the
313 ``devtool update-recipe`` command. These options allow you to specify
316 $ devtool update-recipe recipe -a base-layer-directory
323 .. _devtool-checking-on-the-upgrade-status-of-a-recipe:
332 ``devtool latest-version recipe`` command, which quickly shows the current
334 picture, use the ``devtool check-upgrade-status`` command, which takes a
349 - Most of the time, the above variables are unnecessary. They are only
353 - For the ``oe-core`` layer, recipe maintainers come from the
357 …- If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git f…
366 $ devtool check-upgrade-status -h
368 usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]]
376 -h, --help show this help message and exit
377 --all, -a Show all recipes, not just recipes needing upgrade
383 Notice the reported reason for not upgrading the ``base-passwd`` recipe.
388 See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
393 $ devtool check-upgrade-status
399 …-passwd 3.5.29 3.5.51 Anuj Mittal <anuj.mittal@intel.com> cannot …
406 .. _devtool-upgrading-a-recipe:
412 a developer, you need to keep your local recipes up-to-date with the
414 You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`"
419 the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" section
425 necessary, extracts the source tree to a specified location. During the
431 supply the directory to which you want the source extracted. Additional
433 which you want to upgrade (i.e. the :term:`PV`), the source
439 ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that sup…
442 how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``"
445 .. _devtool-resetting-a-recipe:
450 Use the ``devtool reset`` command to remove a recipe and its
456 the ``devtool reset`` command.
458 If the ``devtool reset`` command detects that the recipe or the append
465 $ devtool reset mtr
467 …NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer …
470 .. _devtool-building-your-recipe:
477 ``bitbake -c populate_sysroot`` command.
481 You can use either the ``-s`` or the ``--disable-parallel-make`` options to
486 .. _devtool-building-your-image:
491 Use the ``devtool build-image`` command to build an image, extending it
497 When you use the ``devtool build-image`` command, you must supply the
500 $ devtool build-image image
502 .. _devtool-deploying-your-software-on-the-target-machine:
507 Use the ``devtool deploy-target`` command to deploy the recipe's build
510 $ devtool deploy-target recipe target
516 :ref:`ref-tasks-install` task. Furthermore, you do not
522 The ``deploy-target`` functionality is for development only. You
531 - You are deploying a new application to the target and the recipe you
535 - The target does not physically have the packages on which the
540 ``devtool deploy-target`` command does not deploy the packages (e.g.
547 to be sure that the packages are pre-deployed (installed) on the target
550 .. _devtool-removing-your-software-from-the-target-machine:
555 Use the ``devtool undeploy-target`` command to remove deployed build
556 output from the target machine. For the ``devtool undeploy-target``
558 ":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target ma…
562 $ devtool undeploy-target recipe target
568 .. _devtool-creating-the-workspace:
573 Use the ``devtool create-workspace`` command to create a new workspace
581 $ devtool create-workspace
585 "new-workspace"::
587 $ devtool create-workspace /home/scottrif/new-workspace
589 .. _devtool-get-the-status-of-the-recipes-in-your-workspace:
596 source trees.
598 The ``devtool status`` command has no command-line options::
603 :ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>`
610 .. _devtool-search-for-available-target-recipes: