summaryrefslogtreecommitdiffstats
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
parent4bbd39d00be476ebae0c46b3de75829b8591f8e5 (diff)
downloadpoky-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>
-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 @@
1970 <filename>devtool</filename> command is using the 1970 <filename>devtool</filename> command is using the
1971 <filename>--help</filename> option: 1971 <filename>--help</filename> option:
1972 <literallayout class='monospaced'> 1972 <literallayout class='monospaced'>
1973 $ devtool --help 1973 usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q]
1974 usage: devtool [-h] [--basepath BASEPATH] [-d] [-q] [--color COLOR] 1974 [--color COLOR] [-h]
1975 &lt;subcommand&gt; ... 1975 &lt;subcommand&gt; ...
1976 1976
1977 OpenEmbedded development tool 1977 OpenEmbedded development tool
1978 1978
1979 optional arguments: 1979 optional arguments:
1980 -h, --help show this help message and exit
1981 --basepath BASEPATH Base directory of SDK / build directory 1980 --basepath BASEPATH Base directory of SDK / build directory
1981 --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it
1982 from the metadata
1982 -d, --debug Enable debug output 1983 -d, --debug Enable debug output
1983 -q, --quiet Print only errors 1984 -q, --quiet Print only errors
1984 --color COLOR Colorize output (where COLOR is auto, always, never) 1985 --color COLOR Colorize output (where COLOR is auto, always, never)
1986 -h, --help show this help message and exit
1985 1987
1986 subcommands: 1988 subcommands:
1987 &lt;subcommand&gt; 1989 &lt;subcommand&gt;
1988 create-workspace Set up a workspace 1990 create-workspace Set up workspace in an alternative location
1991 upgrade Upgrade an existing recipe
1989 deploy-target Deploy recipe output files to live target machine 1992 deploy-target Deploy recipe output files to live target machine
1990 undeploy-target Undeploy recipe output files in live target machine 1993 undeploy-target Undeploy recipe output files in live target machine
1994 search Search available recipes
1995 build Build a recipe
1991 add Add a new recipe 1996 add Add a new recipe
1992 modify Modify the source for an existing recipe 1997 modify Modify the source for an existing recipe
1993 extract Extract the source for an existing recipe 1998 extract Extract the source for an existing recipe
1999 sync Synchronize the source tree for an existing recipe
1994 update-recipe Apply changes from external source tree to recipe 2000 update-recipe Apply changes from external source tree to recipe
1995 status Show workspace status 2001 status Show workspace status
1996 build Build a recipe
1997 reset Remove a recipe from your workspace 2002 reset Remove a recipe from your workspace
2003 edit-recipe Edit a recipe file in your workspace
2004 build-image Build image including workspace recipe packages
1998 2005
1999 Use devtool &lt;subcommand&gt; --help to get help on a specific command 2006 Use devtool &lt;subcommand&gt; --help to get help on a specific command
2000 </literallayout> 2007 </literallayout>
@@ -2006,22 +2013,40 @@
2006 name and using <filename>--help</filename>: 2013 name and using <filename>--help</filename>:
2007 <literallayout class='monospaced'> 2014 <literallayout class='monospaced'>
2008 $ devtool add --help 2015 $ devtool add --help
2009 usage: devtool add [-h] [--same-dir] [--fetch URI] [--version VERSION] 2016 usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI]
2010 recipename srctree 2017 [--version VERSION] [--no-git] [--binary] [--also-native]
2018 [recipename] [srctree] [fetchuri]
2011 2019
2012 Adds a new recipe 2020 Adds a new recipe to the workspace to build a specified source tree. Can
2021 optionally fetch a remote URI and unpack it to create the source tree.
2013 2022
2014 positional arguments: 2023 positional arguments:
2015 recipename Name for new recipe to add 2024 recipename Name for new recipe to add (just name - no version,
2016 srctree Path to external source tree 2025 path or extension). If not specified, will attempt to
2026 auto-detect it.
2027 srctree Path to external source tree. If not specified, a
2028 subdirectory of
2029 /home/<replaceable>user</replaceable>/poky/build/workspace/sources will be
2030 used.
2031 fetchuri Fetch the specified URI and extract it to create the
2032 source tree
2017 2033
2018 optional arguments: 2034 optional arguments:
2019 -h, --help show this help message and exit 2035 -h, --help show this help message and exit
2020 --same-dir, -s Build in same directory as source 2036 --same-dir, -s Build in same directory as source
2037 --no-same-dir Force build in a separate build directory
2021 --fetch URI, -f URI Fetch the specified URI and extract it to create the 2038 --fetch URI, -f URI Fetch the specified URI and extract it to create the
2022 source tree 2039 source tree (deprecated - pass as positional argument
2040 instead)
2023 --version VERSION, -V VERSION 2041 --version VERSION, -V VERSION
2024 Version to use within recipe (PV) 2042 Version to use within recipe (PV)
2043 --no-git, -g If fetching source, do not set up source tree as a git
2044 repository
2045 --binary, -b Treat the source tree as something that should be
2046 installed verbatim (no compilation, same directory
2047 structure). Useful with binary packages e.g. RPMs.
2048 --also-native Also add native variant (i.e. support building recipe
2049 for the build host as well as the target machine)
2025 </literallayout> 2050 </literallayout>
2026 </para> 2051 </para>
2027 </section> 2052 </section>