mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 12:29:55 +00:00
Code Issues Projects Releases Wiki Activity

ref-manual: Provided an introductory text to the devtool ref.

Browse Source 
I put in some introductory material for the new devtool
quick reference chapter.

(From yocto-docs rev: dc46f47692a533ac2450bf459c098435c57e6c07)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2016-09-21 11:42:17 -07:00
committed by Richard Purdie
parent 39639ad3ea
commit 4404fc3fe0
1 changed files with 413 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-devtool-reference.xml
+413 -392
View File
@@ -5,14 +5,35 @@
<chapter id='ref-devtool-reference'> <chapter id='ref-devtool-reference'>
<title><filename>devtool</filename> Quick Reference</title> <title><filename>devtool</filename> Quick Reference</title>
<section id='devtool-getting-help'> <para>
<title>Getting Help</title> The <filename>devtool</filename> command is pivotal when using an
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>extensible SDK</ulink>.
This command-line tool provides a number of features that help you
build, test and package software within the extensible SDK, and
optionally integrate it into an image built by the OpenEmbedded build
system.
</para>
<para> <para>
The easiest way to get help with the This chapter provides a Quick Reference for the
<filename>devtool</filename> command is using the <filename>devtool</filename> command.
<filename>--help</filename> option: For more information on how to apply the command, see the
<literallayout class='monospaced'> "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>Using the Extensible SDK</ulink>"
section in the Yocto Project Software Development Kit (SDK) Developer's
Guide.
</para>
<section id='devtool-getting-help'>
<title>Getting Help</title>
<para>
The <filename>devtool</filename> command line is organized
similarly to Git in that it has a number of sub-commands for
each function.
You can run <filename>devtool --help</filename> to see all
the commands:
<literallayout class='monospaced'>
$ devtool --help
usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q]
[--color COLOR] [-h] [--color COLOR] [-h]
&lt;subcommand&gt; ... &lt;subcommand&gt; ...
@@ -52,14 +73,14 @@
extract Extract the source for an existing recipe extract Extract the source for an existing recipe
sync Synchronize the source tree for an existing recipe sync Synchronize the source tree for an existing recipe
Use devtool &lt;subcommand&gt; --help to get help on a specific command Use devtool &lt;subcommand&gt; --help to get help on a specific command
</literallayout> </literallayout>
</para> </para>
<para> <para>
As directed in the general help output, you can get more As directed in the general help output, you can get more
syntax on a specific command by providing the command syntax on a specific command by providing the command
name and using <filename>--help</filename>: name and using <filename>--help</filename>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool add --help $ devtool add --help
usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI]
[--version VERSION] [--no-git] [--autorev] [--binary] [--version VERSION] [--no-git] [--autorev] [--binary]
@@ -99,32 +120,32 @@
--also-native Also add native variant (i.e. support building recipe --also-native Also add native variant (i.e. support building recipe
for the build host as well as the target machine) for the build host as well as the target machine)
--src-subdir SUBDIR Specify subdirectory within source tree to use --src-subdir SUBDIR Specify subdirectory within source tree to use
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-the-workspace-layer-structure'> <section id='devtool-the-workspace-layer-structure'>
<title>The Workspace Layer Structure</title> <title>The Workspace Layer Structure</title>
<para> <para>
<filename>devtool</filename> uses a "Workspace" layer <filename>devtool</filename> uses a "Workspace" layer
in which to accomplish builds. in which to accomplish builds.
This layer is not specific to any single This layer is not specific to any single
<filename>devtool</filename> command but is rather a common <filename>devtool</filename> command but is rather a common
working area used across the tool. working area used across the tool.
</para> </para>
<para> <para>
The following figure shows the workspace structure: The following figure shows the workspace structure:
</para> </para>
<para> <para>
<imagedata fileref="figures/build-workspace-directory.png" <imagedata fileref="figures/build-workspace-directory.png"
width="6in" depth="5in" align="left" scale="70" /> width="6in" depth="5in" align="left" scale="70" />
</para> </para>
<para> <para>
<literallayout class='monospaced'> <literallayout class='monospaced'>
attic - A directory created if devtool believes it preserve attic - A directory created if devtool believes it preserve
anything when you run "devtool reset". For example, if you anything when you run "devtool reset". For example, if you
run "devtool add", make changes to the recipe, and then run "devtool add", make changes to the recipe, and then
@@ -152,433 +173,433 @@
as the location of the source tree when you do not provide a as the location of the source tree when you do not provide a
source tree path. This directory contains a folder for each source tree path. This directory contains a folder for each
set of source files matched to a corresponding recipe. set of source files matched to a corresponding recipe.
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-adding-a-new-recipe-to-the-workspace'> <section id='devtool-adding-a-new-recipe-to-the-workspace'>
<title>Adding a New Recipe to the Workspace Layer</title> <title>Adding a New Recipe to the Workspace Layer</title>
<para> <para>
Use the <filename>devtool add</filename> command to add a new recipe Use the <filename>devtool add</filename> command to add a new recipe
to the workspace layer. to the workspace layer.
The recipe you add should not exist - The recipe you add should not exist -
<filename>devtool</filename> creates it for you. <filename>devtool</filename> creates it for you.
The source files the recipe uses should exist in an external The source files the recipe uses should exist in an external
area. area.
</para> </para>
<para> <para>
The following example creates and adds a new recipe named The following example creates and adds a new recipe named
<filename>jackson</filename> to a workspace layer the tool creates. <filename>jackson</filename> to a workspace layer the tool creates.
The source code built by the recipes resides in The source code built by the recipes resides in
<filename>/home/scottrif/sources/jackson</filename>: <filename>/home/scottrif/sources/jackson</filename>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool add jackson /home/scottrif/sources/jackson $ devtool add jackson /home/scottrif/sources/jackson
</literallayout> </literallayout>
</para> </para>
<para> <para>
If you add a recipe and the workspace layer does not exist, If you add a recipe and the workspace layer does not exist,
the command creates the layer and populates it as the command creates the layer and populates it as
described in described in
"<link linkend='devtool-the-workspace-layer-structure'>The Workspace Layer Structure</link>" "<link linkend='devtool-the-workspace-layer-structure'>The Workspace Layer Structure</link>"
section. section.
</para> </para>
<para> <para>
Running <filename>devtool add</filename> when the Running <filename>devtool add</filename> when the
workspace layer exists causes the tool to add the recipe, workspace layer exists causes the tool to add the recipe,
append files, and source files into the existing workspace layer. append files, and source files into the existing workspace layer.
The <filename>.bbappend</filename> file is created to point The <filename>.bbappend</filename> file is created to point
to the external source tree. to the external source tree.
</para> </para>
</section> </section>
<section id='devtool-extracting-the-source-for-an-existing-recipe'> <section id='devtool-extracting-the-source-for-an-existing-recipe'>
<title>Extracting the Source for an Existing Recipe</title> <title>Extracting the Source for an Existing Recipe</title>
<para> <para>
Use the <filename>devtool extract</filename> command to Use the <filename>devtool extract</filename> command to
extract the source for an existing recipe. extract the source for an existing recipe.
When you use this command, you must supply the root name When you use this command, you must supply the root name
of the recipe (i.e. no version, paths, or extensions), and of the recipe (i.e. no version, paths, or extensions), and
you must supply the directory to which you want the source you must supply the directory to which you want the source
extracted. extracted.
</para> </para>
<para> <para>
Additional command options let you control the name of a Additional command options let you control the name of a
development branch into which you can checkout the source development branch into which you can checkout the source
and whether or not to keep a temporary directory, which is and whether or not to keep a temporary directory, which is
useful for debugging. useful for debugging.
</para> </para>
</section> </section>
<section id='devtool-synchronizing-a-recipes-extracted-source-tree'> <section id='devtool-synchronizing-a-recipes-extracted-source-tree'>
<title>Synchronizing a Recipe's Extracted Source Tree</title> <title>Synchronizing a Recipe's Extracted Source Tree</title>
<para> <para>
Use the <filename>devtool sync</filename> command to Use the <filename>devtool sync</filename> command to
synchronize a previously extracted source tree for an synchronize a previously extracted source tree for an
existing recipe. existing recipe.
When you use this command, you must supply the root name When you use this command, you must supply the root name
of the recipe (i.e. no version, paths, or extensions), and of the recipe (i.e. no version, paths, or extensions), and
you must supply the directory to which you want the source you must supply the directory to which you want the source
extracted. extracted.
</para> </para>
<para> <para>
Additional command options let you control the name of a Additional command options let you control the name of a
development branch into which you can checkout the source development branch into which you can checkout the source
and whether or not to keep a temporary directory, which is and whether or not to keep a temporary directory, which is
useful for debugging. useful for debugging.
</para> </para>
</section> </section>
<section id='devtool-modifying-a-recipe'> <section id='devtool-modifying-a-recipe'>
<title>Modifying an Existing Recipe</title> <title>Modifying an Existing Recipe</title>
<para> <para>
Use the <filename>devtool modify</filename> command to begin Use the <filename>devtool modify</filename> command to begin
modifying the source of an existing recipe. modifying the source of an existing recipe.
This command is very similar to the This command is very similar to the
<ulink url='&YOCTO_DOCS_DEV_URL;#devtool-adding-a-new-recipe-to-the-workspace'><filename>add</filename></ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#devtool-adding-a-new-recipe-to-the-workspace'><filename>add</filename></ulink>
command except that it does not physically create the command except that it does not physically create the
recipe in the workspace layer because the recipe already recipe in the workspace layer because the recipe already
exists in an another layer. exists in an another layer.
</para> </para>
<para> <para>
The <filename>devtool modify</filename> command extracts the The <filename>devtool modify</filename> command extracts the
source for a recipe, sets it up as a Git repository if the source for a recipe, sets it up as a Git repository if the
source had not already been fetched from Git, checks out a source had not already been fetched from Git, checks out a
branch for development, and applies any patches from the recipe branch for development, and applies any patches from the recipe
as commits on top. as commits on top.
You can use the following command to checkout the source You can use the following command to checkout the source
files: files:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool modify <replaceable>recipe</replaceable> $ devtool modify <replaceable>recipe</replaceable>
</literallayout> </literallayout>
Using the above command form, <filename>devtool</filename> uses Using the above command form, <filename>devtool</filename> uses
the existing recipe's the existing recipe's
<link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
statement to locate the upstream source, extracts the source statement to locate the upstream source, extracts the source
into the default sources location in the workspace. into the default sources location in the workspace.
The default development branch used is "devtool". The default development branch used is "devtool".
</para> </para>
</section> </section>
<section id='devtool-edit-an-existing-recipe'> <section id='devtool-edit-an-existing-recipe'>
<title>Edit an Existing Recipe</title> <title>Edit an Existing Recipe</title>
<para> <para>
Use the <filename>devtool edit-recipe</filename> command Use the <filename>devtool edit-recipe</filename> command
to run the default editor, which is identified using the to run the default editor, which is identified using the
<filename>EDITOR</filename> variable, on the specified recipe. <filename>EDITOR</filename> variable, on the specified recipe.
</para> </para>
<para> <para>
When you use the <filename>devtool edit-recipe</filename> When you use the <filename>devtool edit-recipe</filename>
command, you must supply the root name of the recipe command, you must supply the root name of the recipe
(i.e. no version, paths, or extensions). (i.e. no version, paths, or extensions).
Also, the recipe file itself must reside in the workspace Also, the recipe file itself must reside in the workspace
as a result of the <filename>devtool add</filename> or as a result of the <filename>devtool add</filename> or
<filename>devtool upgrade</filename> commands. <filename>devtool upgrade</filename> commands.
However, you can override that requirement by using the However, you can override that requirement by using the
"-a" or "--any-recipe" option. "-a" or "--any-recipe" option.
Using either of these options allows you to edit any recipe Using either of these options allows you to edit any recipe
regardless of its location. regardless of its location.
</para> </para>
</section> </section>
<section id='devtool-updating-a-recipe'> <section id='devtool-updating-a-recipe'>
<title>Updating a Recipe</title> <title>Updating a Recipe</title>
<para> <para>
Use the <filename>devtool update-recipe</filename> command to Use the <filename>devtool update-recipe</filename> command to
update your recipe with patches that reflect changes you make update your recipe with patches that reflect changes you make
to the source files. to the source files.
For example, if you know you are going to work on some For example, if you know you are going to work on some
code, you could first use the code, you could first use the
<ulink url='&YOCTO_DOCS_DEV_URL;#devtool-modifying-a-recipe'><filename>devtool modify</filename></ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#devtool-modifying-a-recipe'><filename>devtool modify</filename></ulink>
command to extract the code and set up the workspace. command to extract the code and set up the workspace.
After which, you could modify, compile, and test the code. After which, you could modify, compile, and test the code.
</para> </para>
<para> <para>
When you are satisfied with the results and you have committed When you are satisfied with the results and you have committed
your changes to the Git repository, you can then your changes to the Git repository, you can then
run the <filename>devtool update-recipe</filename> to create the run the <filename>devtool update-recipe</filename> to create the
patches and update the recipe: patches and update the recipe:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool update-recipe <replaceable>recipe</replaceable> $ devtool update-recipe <replaceable>recipe</replaceable>
</literallayout> </literallayout>
If you run the <filename>devtool update-recipe</filename> If you run the <filename>devtool update-recipe</filename>
without committing your changes, the command ignores the without committing your changes, the command ignores the
changes. changes.
</para> </para>
<para> <para>
Often, you might want to apply customizations made to your Often, you might want to apply customizations made to your
software in your own layer rather than apply them to the software in your own layer rather than apply them to the
original recipe. original recipe.
If so, you can use the If so, you can use the
<filename>-a</filename> or <filename>--append</filename> <filename>-a</filename> or <filename>--append</filename>
option with the <filename>devtool update-recipe</filename> option with the <filename>devtool update-recipe</filename>
command. command.
These options allow you to specify the layer into which to These options allow you to specify the layer into which to
write an append file: write an append file:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool update-recipe <replaceable>recipe</replaceable> -a <replaceable>base-layer-directory</replaceable> $ devtool update-recipe <replaceable>recipe</replaceable> -a <replaceable>base-layer-directory</replaceable>
</literallayout> </literallayout>
The <filename>*.bbappend</filename> file is created at the The <filename>*.bbappend</filename> file is created at the
appropriate path within the specified layer directory, which appropriate path within the specified layer directory, which
may or may not be in your <filename>bblayers.conf</filename> may or may not be in your <filename>bblayers.conf</filename>
file. file.
If an append file already exists, the command updates it If an append file already exists, the command updates it
appropriately. appropriately.
</para> </para>
</section> </section>
<section id='devtool-upgrading-a-recipe'> <section id='devtool-upgrading-a-recipe'>
<title>Upgrading a Recipe</title> <title>Upgrading a Recipe</title>
<para> <para>
Use the <filename>devtool upgrade</filename> command Use the <filename>devtool upgrade</filename> command
to upgrade an existing recipe to a new upstream version. to upgrade an existing recipe to a new upstream version.
The command puts the upgraded recipe file into the The command puts the upgraded recipe file into the
workspace along with any associated files, and extracts workspace along with any associated files, and extracts
the source tree to a specified location should patches the source tree to a specified location should patches
need rebased or added to as a result of the upgrade. need rebased or added to as a result of the upgrade.
</para> </para>
<para> <para>
When you use the <filename>devtool upgrade</filename> command, When you use the <filename>devtool upgrade</filename> command,
you must supply the root name of the recipe (i.e. no version, you must supply the root name of the recipe (i.e. no version,
paths, or extensions), and you must supply the directory paths, or extensions), and you must supply the directory
to which you want the source extracted. to which you want the source extracted.
Additional command options let you control things such as Additional command options let you control things such as
the version number to which you want to upgrade (i.e. the the version number to which you want to upgrade (i.e. the
<link linkend='var-PV'><filename>PV</filename></link>), <link linkend='var-PV'><filename>PV</filename></link>),
the source revision to which you want to upgrade (i.e. the the source revision to which you want to upgrade (i.e. the
<link linkend='var-SRCREV'><filename>SRCREV</filename></link>, <link linkend='var-SRCREV'><filename>SRCREV</filename></link>,
whether or not to apply patches, and so forth. whether or not to apply patches, and so forth.
</para> </para>
</section> </section>
<section id='devtool-resetting-a-recipe'> <section id='devtool-resetting-a-recipe'>
<title>Resetting a Recipe</title> <title>Resetting a Recipe</title>
<para> <para>
Use the <filename>devtool reset</filename> command to remove a Use the <filename>devtool reset</filename> command to remove a
recipe and its configuration (e.g. the corresponding recipe and its configuration (e.g. the corresponding
<filename>.bbappend</filename> file) from the workspace layer. <filename>.bbappend</filename> file) from the workspace layer.
Realize that this command deletes the recipe and the Realize that this command deletes the recipe and the
append file. append file.
The command does not physically move them for you. The command does not physically move them for you.
Consequently, you must be sure to physically relocate your Consequently, you must be sure to physically relocate your
updated recipe and the append file outside of the workspace updated recipe and the append file outside of the workspace
layer before running the <filename>devtool reset</filename> layer before running the <filename>devtool reset</filename>
command. command.
</para> </para>
<para> <para>
If the <filename>devtool reset</filename> command detects that If the <filename>devtool reset</filename> command detects that
the recipe or the append files have been modified, the the recipe or the append files have been modified, the
command preserves the modified files in a separate "attic" command preserves the modified files in a separate "attic"
subdirectory under the workspace layer. subdirectory under the workspace layer.
</para> </para>
<para> <para>
Here is an example that resets the workspace directory that Here is an example that resets the workspace directory that
contains the <filename>mtr</filename> recipe: contains the <filename>mtr</filename> recipe:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool reset mtr $ devtool reset mtr
NOTE: Cleaning sysroot for recipe mtr... NOTE: Cleaning sysroot for recipe mtr...
NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no
longer need it then please delete it manually longer need it then please delete it manually
$ $
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-building-your-recipe'> <section id='devtool-building-your-recipe'>
<title>Building Your Recipe</title> <title>Building Your Recipe</title>
<para> <para>
Use the <filename>devtool build</filename> command to cause the Use the <filename>devtool build</filename> command to cause the
OpenEmbedded build system to build your recipe. OpenEmbedded build system to build your recipe.
The <filename>devtool build</filename> command is equivalent to The <filename>devtool build</filename> command is equivalent to
<filename>bitbake -c populate_sysroot</filename>. <filename>bitbake -c populate_sysroot</filename>.
</para> </para>
<para> <para>
When you use the <filename>devtool build</filename> command, When you use the <filename>devtool build</filename> command,
you must supply the root name of the recipe (i.e. no version, you must supply the root name of the recipe (i.e. no version,
paths, or extensions). paths, or extensions).
You can use either the "-s" or the "--disable-parallel-make" You can use either the "-s" or the "--disable-parallel-make"
option to disable parallel makes during the build. option to disable parallel makes during the build.
Here is an example: Here is an example:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool build <replaceable>recipe</replaceable> $ devtool build <replaceable>recipe</replaceable>
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-building-your-image'> <section id='devtool-building-your-image'>
<title>Building Your Image</title> <title>Building Your Image</title>
<para> <para>
Use the <filename>devtool build-image</filename> command Use the <filename>devtool build-image</filename> command
to build an image, extending it to include packages from to build an image, extending it to include packages from
recipes in the workspace. recipes in the workspace.
Using this command is useful when you want an image that Using this command is useful when you want an image that
ready for immediate deployment onto a device for testing. ready for immediate deployment onto a device for testing.
For proper integration into a final image, you need to For proper integration into a final image, you need to
edit your custom image recipe appropriately. edit your custom image recipe appropriately.
</para> </para>
<para> <para>
When you use the <filename>devtool build-image</filename> When you use the <filename>devtool build-image</filename>
command, you must supply the name of the image. command, you must supply the name of the image.
This command has no command line options: This command has no command line options:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool build-image <replaceable>image</replaceable> $ devtool build-image <replaceable>image</replaceable>
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-deploying-your-software-on-the-target-machine'> <section id='devtool-deploying-your-software-on-the-target-machine'>
<title>Deploying Your Software on the Target Machine</title> <title>Deploying Your Software on the Target Machine</title>
<para> <para>
Use the <filename>devtool deploy-target</filename> command to Use the <filename>devtool deploy-target</filename> command to
deploy the recipe's build output to the live target machine: deploy the recipe's build output to the live target machine:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool deploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable> $ devtool deploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable>
</literallayout> </literallayout>
The <replaceable>target</replaceable> is the address of the The <replaceable>target</replaceable> is the address of the
target machine, which must be running an SSH server (i.e. target machine, which must be running an SSH server (i.e.
<filename>user@hostname[:destdir]</filename>). <filename>user@hostname[:destdir]</filename>).
</para> </para>
<para> <para>
This command deploys all files installed during the This command deploys all files installed during the
<link linkend='ref-tasks-install'><filename>do_install</filename></link> <link linkend='ref-tasks-install'><filename>do_install</filename></link>
task. task.
Furthermore, you do not need to have package management enabled Furthermore, you do not need to have package management enabled
within the target machine. within the target machine.
If you do, the package manager is bypassed. If you do, the package manager is bypassed.
<note><title>Notes</title> <note><title>Notes</title>
<para> <para>
The <filename>deploy-target</filename> The <filename>deploy-target</filename>
functionality is for development only. functionality is for development only.
You should never use it to update an image that will be You should never use it to update an image that will be
used in production. used in production.
</para> </para>
</note> </note>
</para> </para>
</section> </section>
<section id='devtool-removing-your-software-from-the-target-machine'> <section id='devtool-removing-your-software-from-the-target-machine'>
<title>Removing Your Software from the Target Machine</title> <title>Removing Your Software from the Target Machine</title>
<para> <para>
Use the <filename>devtool undeploy-target</filename> command to Use the <filename>devtool undeploy-target</filename> command to
remove deployed build output from the target machine. remove deployed build output from the target machine.
For the <filename>devtool undeploy-target</filename> command to For the <filename>devtool undeploy-target</filename> command to
work, you must have previously used the work, you must have previously used the
<ulink url='&YOCTO_DOCS_DEV_URL;#devtool-deploying-your-software-on-the-target-machine'><filename>devtool deploy-target</filename></ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#devtool-deploying-your-software-on-the-target-machine'><filename>devtool deploy-target</filename></ulink>
command. command.
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool undeploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable> $ devtool undeploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable>
</literallayout> </literallayout>
The <replaceable>target</replaceable> is the address of the The <replaceable>target</replaceable> is the address of the
target machine, which must be running an SSH server (i.e. target machine, which must be running an SSH server (i.e.
<filename>user@hostname</filename>). <filename>user@hostname</filename>).
</para> </para>
</section> </section>
<section id='devtool-creating-the-workspace'> <section id='devtool-creating-the-workspace'>
<title>Creating the Workspace Layer in an Alternative Location</title> <title>Creating the Workspace Layer in an Alternative Location</title>
<para> <para>
Use the <filename>devtool create-workspace</filename> command to Use the <filename>devtool create-workspace</filename> command to
create a new workspace layer in your create a new workspace layer in your
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
When you create a new workspace layer, it is populated with the When you create a new workspace layer, it is populated with the
<filename>README</filename> file and the <filename>README</filename> file and the
<filename>conf</filename> directory only. <filename>conf</filename> directory only.
</para> </para>
<para> <para>
The following example creates a new workspace layer in your The following example creates a new workspace layer in your
current working and by default names the workspace layer current working and by default names the workspace layer
"workspace": "workspace":
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool create-workspace $ devtool create-workspace
</literallayout> </literallayout>
</para> </para>
<para> <para>
You can create a workspace layer anywhere by supplying You can create a workspace layer anywhere by supplying
a pathname with the command. a pathname with the command.
The following command creates a new workspace layer named The following command creates a new workspace layer named
"new-workspace": "new-workspace":
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool create-workspace /home/scottrif/new-workspace $ devtool create-workspace /home/scottrif/new-workspace
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-get-the-status-of-the-recipes-in-your-workspace'> <section id='devtool-get-the-status-of-the-recipes-in-your-workspace'>
<title>Get the Status of the Recipes in Your Workspace</title> <title>Get the Status of the Recipes in Your Workspace</title>
<para> <para>
Use the <filename>devtool status</filename> command to Use the <filename>devtool status</filename> command to
list the recipes currently in your workspace. list the recipes currently in your workspace.
Information includes the paths to their respective Information includes the paths to their respective
external source trees. external source trees.
</para> </para>
<para> <para>
The <filename>devtool status</filename> command has no The <filename>devtool status</filename> command has no
command-line options: command-line options:
<literallayout class='monospaced'> <literallayout class='monospaced'>
devtool status $ devtool status
</literallayout> </literallayout>
Following is sample output after using Following is sample output after using
<ulink url='&YOCTO_DOCS_DEV_URL;#devtool-adding-a-new-recipe-to-the-workspace'><filename>devtool add</filename></ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#devtool-adding-a-new-recipe-to-the-workspace'><filename>devtool add</filename></ulink>
to create and add the <filename>mtr_0.86.bb</filename> recipe to create and add the <filename>mtr_0.86.bb</filename> recipe
to the <filename>workspace</filename> directory: to the <filename>workspace</filename> directory:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool status $ devtool status
mtr: /home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) mtr: /home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb)
$ $
</literallayout> </literallayout>
</para> </para>
</section> </section>
<section id='devtool-search-for-available-target-recipes'> <section id='devtool-search-for-available-target-recipes'>
<title>Search for Available Target Recipes</title> <title>Search for Available Target Recipes</title>
<para> <para>
Use the <filename>devtool search</filename> command to Use the <filename>devtool search</filename> command to
search for available target recipes. search for available target recipes.
The command matches the recipe name, package name, The command matches the recipe name, package name,
description, and installed files. description, and installed files.
The command displays the recipe name as a result of a The command displays the recipe name as a result of a
match. match.
</para> </para>
<para> <para>
When you use the <filename>devtool search</filename> command, When you use the <filename>devtool search</filename> command,
you must supply a <replaceable>keyword</replaceable>. you must supply a <replaceable>keyword</replaceable>.
The command uses the <replaceable>keyword</replaceable> when The command uses the <replaceable>keyword</replaceable> when
searching for a match. searching for a match.
</para> </para>
</section> </section>
</chapter> </chapter>
<!-- <!--
vim: expandtab tw=80 ts=4 vim: expandtab tw=80 ts=4