diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-03-06 13:11:06 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-03-25 09:41:11 +0100 |
commit | 7e87668beec7b2081eb4bd7a4f32850eabdeeff7 (patch) | |
tree | 25532141748fd8627758d89c4b83134f568f8a85 /documentation/ref-manual/ref-devtool-reference.xml | |
parent | 51347f576af4ac4a959c282ddd4d86fdb3cd606d (diff) | |
download | poky-7e87668beec7b2081eb4bd7a4f32850eabdeeff7.tar.gz |
ref-manual: Updated devtool sections
Updated the devtool add -h output.
Updated the devtool --help output.
Fixed wording for the "attic" file associated with the figure
of the workspace area.
(From yocto-docs rev: bc53d9a1236ba2545c112256e886729b08b507de)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-devtool-reference.xml')
-rw-r--r-- | documentation/ref-manual/ref-devtool-reference.xml | 113 |
1 files changed, 60 insertions, 53 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml index e4d27bfe50..0b44585287 100644 --- a/documentation/ref-manual/ref-devtool-reference.xml +++ b/documentation/ref-manual/ref-devtool-reference.xml | |||
@@ -35,59 +35,51 @@ | |||
35 | the commands: | 35 | the commands: |
36 | <literallayout class='monospaced'> | 36 | <literallayout class='monospaced'> |
37 | $ devtool --help | 37 | $ devtool --help |
38 | usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] | 38 | NOTE: Starting bitbake server... |
39 | [--fetch-dev] [--version VERSION] [--no-git] | 39 | usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] |
40 | [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] | 40 | [--color COLOR] [-h] |
41 | [--binary] [--also-native] [--src-subdir SUBDIR] | 41 | <subcommand> ... |
42 | [--mirrors] [--provides PROVIDES] | ||
43 | [recipename] [srctree] [fetchuri] | ||
44 | 42 | ||
45 | Adds a new recipe to the workspace to build a specified source tree. Can | 43 | OpenEmbedded development tool |
46 | optionally fetch a remote URI and unpack it to create the source tree. | ||
47 | |||
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 | ||
58 | 44 | ||
59 | options: | 45 | options: |
60 | -h, --help show this help message and exit | 46 | --basepath BASEPATH Base directory of SDK / build directory |
61 | --same-dir, -s Build in same directory as source | 47 | --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it |
62 | --no-same-dir Force build in a separate build directory | 48 | from the metadata |
63 | --fetch URI, -f URI Fetch the specified URI and extract it to create | 49 | -d, --debug Enable debug output |
64 | the source tree (deprecated - pass as positional | 50 | -q, --quiet Print only errors |
65 | argument instead) | 51 | --color COLOR Colorize output (where COLOR is auto, always, never) |
66 | --fetch-dev For npm, also fetch devDependencies | 52 | -h, --help show this help message and exit |
67 | --version VERSION, -V VERSION | 53 | |
68 | Version to use within recipe (PV) | 54 | subcommands: |
69 | --no-git, -g If fetching source, do not set up source tree as a | 55 | Beginning work on a recipe: |
70 | git repository | 56 | add Add a new recipe |
71 | --srcrev SRCREV, -S SRCREV | 57 | modify Modify the source for an existing recipe |
72 | Source revision to fetch if fetching from an SCM | 58 | upgrade Upgrade an existing recipe |
73 | such as git (default latest) | 59 | Getting information: |
74 | --autorev, -a When fetching from a git repository, set SRCREV in | 60 | status Show workspace status |
75 | the recipe to a floating revision instead of fixed | 61 | search Search available recipes |
76 | --srcbranch SRCBRANCH, -B SRCBRANCH | 62 | latest-version Report the latest version of an existing recipe |
77 | Branch in source repository if fetching from an SCM | 63 | Working on a recipe in the workspace: |
78 | such as git (default master) | 64 | build Build a recipe |
79 | --binary, -b Treat the source tree as something that should be | 65 | rename Rename a recipe file in the workspace |
80 | installed verbatim (no compilation, same directory | 66 | edit-recipe Edit a recipe file |
81 | structure). Useful with binary packages e.g. RPMs. | 67 | find-recipe Find a recipe file |
82 | --also-native Also add native variant (i.e. support building | 68 | configure-help Get help on configure script options |
83 | recipe for the build host as well as the target | 69 | update-recipe Apply changes from external source tree to recipe |
84 | machine) | 70 | reset Remove a recipe from your workspace |
85 | --src-subdir SUBDIR Specify subdirectory within source tree to use | 71 | finish Finish working on a recipe in your workspace |
86 | --mirrors Enable PREMIRRORS and MIRRORS for source tree | 72 | Testing changes on target: |
87 | fetching (disable by default). | 73 | deploy-target Deploy recipe output files to live target machine |
88 | --provides PROVIDES, -p PROVIDES | 74 | undeploy-target Undeploy recipe output files in live target machine |
89 | Specify an alias for the item provided by the | 75 | build-image Build image including workspace recipe packages |
90 | recipe. E.g. virtual/libgl | 76 | Advanced: |
77 | create-workspace Set up workspace in an alternative location | ||
78 | export Export workspace into a tar archive | ||
79 | import Import exported tar archive into workspace | ||
80 | extract Extract the source for an existing recipe | ||
81 | sync Synchronize the source tree for an existing recipe | ||
82 | Use devtool <subcommand> --help to get help on a specific command | ||
91 | </literallayout> | 83 | </literallayout> |
92 | </para> | 84 | </para> |
93 | 85 | ||
@@ -97,9 +89,12 @@ | |||
97 | name and using <filename>--help</filename>: | 89 | name and using <filename>--help</filename>: |
98 | <literallayout class='monospaced'> | 90 | <literallayout class='monospaced'> |
99 | $ devtool add --help | 91 | $ devtool add --help |
92 | NOTE: Starting bitbake server... | ||
100 | usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] | 93 | usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] |
101 | [--version VERSION] [--no-git] [--autorev] [--binary] | 94 | [--fetch-dev] [--version VERSION] [--no-git] |
102 | [--also-native] [--src-subdir SUBDIR] | 95 | [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] |
96 | [--binary] [--also-native] [--src-subdir SUBDIR] | ||
97 | [--mirrors] [--provides PROVIDES] | ||
103 | [recipename] [srctree] [fetchuri] | 98 | [recipename] [srctree] [fetchuri] |
104 | 99 | ||
105 | Adds a new recipe to the workspace to build a specified source tree. Can | 100 | Adds a new recipe to the workspace to build a specified source tree. Can |
@@ -123,18 +118,30 @@ | |||
123 | --fetch URI, -f URI Fetch the specified URI and extract it to create the | 118 | --fetch URI, -f URI Fetch the specified URI and extract it to create the |
124 | source tree (deprecated - pass as positional argument | 119 | source tree (deprecated - pass as positional argument |
125 | instead) | 120 | instead) |
121 | --fetch-dev For npm, also fetch devDependencies | ||
126 | --version VERSION, -V VERSION | 122 | --version VERSION, -V VERSION |
127 | Version to use within recipe (PV) | 123 | Version to use within recipe (PV) |
128 | --no-git, -g If fetching source, do not set up source tree as a git | 124 | --no-git, -g If fetching source, do not set up source tree as a git |
129 | repository | 125 | repository |
126 | --srcrev SRCREV, -S SRCREV | ||
127 | Source revision to fetch if fetching from an SCM such | ||
128 | as git (default latest) | ||
130 | --autorev, -a When fetching from a git repository, set SRCREV in the | 129 | --autorev, -a When fetching from a git repository, set SRCREV in the |
131 | recipe to a floating revision instead of fixed | 130 | recipe to a floating revision instead of fixed |
131 | --srcbranch SRCBRANCH, -B SRCBRANCH | ||
132 | Branch in source repository if fetching from an SCM | ||
133 | such as git (default master) | ||
132 | --binary, -b Treat the source tree as something that should be | 134 | --binary, -b Treat the source tree as something that should be |
133 | installed verbatim (no compilation, same directory | 135 | installed verbatim (no compilation, same directory |
134 | structure). Useful with binary packages e.g. RPMs. | 136 | structure). Useful with binary packages e.g. RPMs. |
135 | --also-native Also add native variant (i.e. support building recipe | 137 | --also-native Also add native variant (i.e. support building recipe |
136 | for the build host as well as the target machine) | 138 | for the build host as well as the target machine) |
137 | --src-subdir SUBDIR Specify subdirectory within source tree to use | 139 | --src-subdir SUBDIR Specify subdirectory within source tree to use |
140 | --mirrors Enable PREMIRRORS and MIRRORS for source tree fetching | ||
141 | (disable by default). | ||
142 | --provides PROVIDES, -p PROVIDES | ||
143 | Specify an alias for the item provided by the recipe. | ||
144 | E.g. virtual/libgl | ||
138 | </literallayout> | 145 | </literallayout> |
139 | </para> | 146 | </para> |
140 | </section> | 147 | </section> |
@@ -161,7 +168,7 @@ | |||
161 | 168 | ||
162 | <para> | 169 | <para> |
163 | <literallayout class='monospaced'> | 170 | <literallayout class='monospaced'> |
164 | attic - A directory created if devtool believes it preserve | 171 | attic - A directory created if devtool believes it must preserve |
165 | anything when you run "devtool reset". For example, if you | 172 | anything when you run "devtool reset". For example, if you |
166 | run "devtool add", make changes to the recipe, and then | 173 | run "devtool add", make changes to the recipe, and then |
167 | run "devtool reset", devtool takes notice that the file has | 174 | run "devtool reset", devtool takes notice that the file has |