summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml86
1 files changed, 50 insertions, 36 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml
index 64db00e714..b7c0e334ea 100644
--- a/documentation/ref-manual/ref-devtool-reference.xml
+++ b/documentation/ref-manual/ref-devtool-reference.xml
@@ -35,45 +35,59 @@
35 the commands: 35 the commands:
36 <literallayout class='monospaced'> 36 <literallayout class='monospaced'>
37 $ devtool --help 37 $ devtool --help
38 usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] 38 usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI]
39 [--color COLOR] [-h] 39 [--fetch-dev] [--version VERSION] [--no-git]
40 &lt;subcommand&gt; ... 40 [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH]
41 [--binary] [--also-native] [--src-subdir SUBDIR]
42 [--mirrors] [--provides PROVIDES]
43 [recipename] [srctree] [fetchuri]
44
45 Adds a new recipe to the workspace to build a specified source tree. Can
46 optionally fetch a remote URI and unpack it to create the source tree.
41 47
42 OpenEmbedded development tool 48 arguments:
49 recipename Name for new recipe to add (just name - no version,
50 path or extension). If not specified, will attempt
51 to auto-detect it.
52 srctree Path to external source tree. If not specified, a
53 subdirectory of
54 /home/<replaceable>user</replaceable>/poky/build/workspace/sources will be
55 used.
56 fetchuri Fetch the specified URI and extract it to create
57 the source tree
43 58
44 options: 59 options:
45 --basepath BASEPATH Base directory of SDK / build directory 60 -h, --help show this help message and exit
46 --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it 61 --same-dir, -s Build in same directory as source
47 from the metadata 62 --no-same-dir Force build in a separate build directory
48 -d, --debug Enable debug output 63 --fetch URI, -f URI Fetch the specified URI and extract it to create
49 -q, --quiet Print only errors 64 the source tree (deprecated - pass as positional
50 --color COLOR Colorize output (where COLOR is auto, always, never) 65 argument instead)
51 -h, --help show this help message and exit 66 --fetch-dev For npm, also fetch devDependencies
52 67 --version VERSION, -V VERSION
53 subcommands: 68 Version to use within recipe (PV)
54 Beginning work on a recipe: 69 --no-git, -g If fetching source, do not set up source tree as a
55 add Add a new recipe 70 git repository
56 modify Modify the source for an existing recipe 71 --srcrev SRCREV, -S SRCREV
57 upgrade Upgrade an existing recipe 72 Source revision to fetch if fetching from an SCM
58 Getting information: 73 such as git (default latest)
59 status Show workspace status 74 --autorev, -a When fetching from a git repository, set SRCREV in
60 search Search available recipes 75 the recipe to a floating revision instead of fixed
61 Working on a recipe in the workspace: 76 --srcbranch SRCBRANCH, -B SRCBRANCH
62 edit-recipe Edit a recipe file in your workspace 77 Branch in source repository if fetching from an SCM
63 configure-help Get help on configure script options 78 such as git (default master)
64 build Build a recipe 79 --binary, -b Treat the source tree as something that should be
65 update-recipe Apply changes from external source tree to recipe 80 installed verbatim (no compilation, same directory
66 reset Remove a recipe from your workspace 81 structure). Useful with binary packages e.g. RPMs.
67 finish Finish working on a recipe in your workspace 82 --also-native Also add native variant (i.e. support building
68 Testing changes on target: 83 recipe for the build host as well as the target
69 deploy-target Deploy recipe output files to live target machine 84 machine)
70 undeploy-target Undeploy recipe output files in live target machine 85 --src-subdir SUBDIR Specify subdirectory within source tree to use
71 build-image Build image including workspace recipe packages 86 --mirrors Enable PREMIRRORS and MIRRORS for source tree
72 Advanced: 87 fetching (disable by default).
73 create-workspace Set up workspace in an alternative location 88 --provides PROVIDES, -p PROVIDES
74 extract Extract the source for an existing recipe 89 Specify an alias for the item provided by the
75 sync Synchronize the source tree for an existing recipe 90 recipe. E.g. virtual/libgl
76 Use devtool &lt;subcommand&gt; --help to get help on a specific command
77 </literallayout> 91 </literallayout>
78 </para> 92 </para>
79 93