aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-01-18 09:30:34 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-01-29 17:04:47 +0000
commit9f192c81be633e48086ea8e62b07b1b33c79fa26 (patch)
tree2a0464ccbb39554e4a438413d6a8b703c22c36ec /documentation
parent4bbd39d00be476ebae0c46b3de75829b8591f8e5 (diff)
downloadopenembedded-core-contrib-9f192c81be633e48086ea8e62b07b1b33c79fa26.tar.gz
dev-manual: Updated the devtool help examples.
(From yocto-docs rev: ca02638c515a77986f08c392602df105ab9c185a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml49
1 files changed, 37 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 6e42c7b391..ec11824a56 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1970,31 +1970,38 @@
<filename>devtool</filename> command is using the
<filename>--help</filename> option:
<literallayout class='monospaced'>
- $ devtool --help
- usage: devtool [-h] [--basepath BASEPATH] [-d] [-q] [--color COLOR]
- &lt;subcommand&gt; ...
+ usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q]
+ [--color COLOR] [-h]
+ &lt;subcommand&gt; ...
OpenEmbedded development tool
optional arguments:
- -h, --help show this help message and exit
--basepath BASEPATH Base directory of SDK / build directory
+ --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it
+ from the metadata
-d, --debug Enable debug output
-q, --quiet Print only errors
--color COLOR Colorize output (where COLOR is auto, always, never)
+ -h, --help show this help message and exit
subcommands:
&lt;subcommand&gt;
- create-workspace Set up a workspace
+ create-workspace Set up workspace in an alternative location
+ upgrade Upgrade an existing recipe
deploy-target Deploy recipe output files to live target machine
undeploy-target Undeploy recipe output files in live target machine
+ search Search available recipes
+ build Build a recipe
add Add a new recipe
modify Modify the source for an existing recipe
extract Extract the source for an existing recipe
+ sync Synchronize the source tree for an existing recipe
update-recipe Apply changes from external source tree to recipe
status Show workspace status
- build Build a recipe
reset Remove a recipe from your workspace
+ edit-recipe Edit a recipe file in your workspace
+ build-image Build image including workspace recipe packages
Use devtool &lt;subcommand&gt; --help to get help on a specific command
</literallayout>
@@ -2006,22 +2013,40 @@
name and using <filename>--help</filename>:
<literallayout class='monospaced'>
$ devtool add --help
- usage: devtool add [-h] [--same-dir] [--fetch URI] [--version VERSION]
- recipename srctree
+ usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI]
+ [--version VERSION] [--no-git] [--binary] [--also-native]
+ [recipename] [srctree] [fetchuri]
- Adds a new recipe
+ Adds a new recipe to the workspace to build a specified source tree. Can
+ optionally fetch a remote URI and unpack it to create the source tree.
positional arguments:
- recipename Name for new recipe to add
- srctree Path to external source tree
+ recipename Name for new recipe to add (just name - no version,
+ path or extension). If not specified, will attempt to
+ auto-detect it.
+ srctree Path to external source tree. If not specified, a
+ subdirectory of
+ /home/<replaceable>user</replaceable>/poky/build/workspace/sources will be
+ used.
+ fetchuri Fetch the specified URI and extract it to create the
+ source tree
optional arguments:
-h, --help show this help message and exit
--same-dir, -s Build in same directory as source
+ --no-same-dir Force build in a separate build directory
--fetch URI, -f URI Fetch the specified URI and extract it to create the
- source tree
+ source tree (deprecated - pass as positional argument
+ instead)
--version VERSION, -V VERSION
Version to use within recipe (PV)
+ --no-git, -g If fetching source, do not set up source tree as a git
+ repository
+ --binary, -b Treat the source tree as something that should be
+ installed verbatim (no compilation, same directory
+ structure). Useful with binary packages e.g. RPMs.
+ --also-native Also add native variant (i.e. support building recipe
+ for the build host as well as the target machine)
</literallayout>
</para>
</section>