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

ref-manual: Updated devtool sections

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2018-03-06 13:11:06 -08:00
committed by Richard Purdie
parent 51347f576a
commit 7e87668bee
1 changed files with 60 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-devtool-reference.xml
+60 -53
View File
@@ -35,59 +35,51 @@
the commands: the commands:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool --help $ devtool --help
usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] NOTE: Starting bitbake server...
[--fetch-dev] [--version VERSION] [--no-git] usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q]
[--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] [--color COLOR] [-h]
[--binary] [--also-native] [--src-subdir SUBDIR] &lt;subcommand&gt; ...
[--mirrors] [--provides PROVIDES]
[recipename] [srctree] [fetchuri]
Adds a new recipe to the workspace to build a specified source tree. Can OpenEmbedded development tool
optionally fetch a remote URI and unpack it to create the source tree.
arguments:
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
options: options:
-h, --help show this help message and exit --basepath BASEPATH Base directory of SDK / build directory
--same-dir, -s Build in same directory as source --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it
--no-same-dir Force build in a separate build directory from the metadata
--fetch URI, -f URI Fetch the specified URI and extract it to create -d, --debug Enable debug output
the source tree (deprecated - pass as positional -q, --quiet Print only errors
argument instead) --color COLOR Colorize output (where COLOR is auto, always, never)
--fetch-dev For npm, also fetch devDependencies -h, --help show this help message and exit
--version VERSION, -V VERSION
Version to use within recipe (PV) subcommands:
--no-git, -g If fetching source, do not set up source tree as a Beginning work on a recipe:
git repository add Add a new recipe
--srcrev SRCREV, -S SRCREV modify Modify the source for an existing recipe
Source revision to fetch if fetching from an SCM upgrade Upgrade an existing recipe
such as git (default latest) Getting information:
--autorev, -a When fetching from a git repository, set SRCREV in status Show workspace status
the recipe to a floating revision instead of fixed search Search available recipes
--srcbranch SRCBRANCH, -B SRCBRANCH latest-version Report the latest version of an existing recipe
Branch in source repository if fetching from an SCM Working on a recipe in the workspace:
such as git (default master) build Build a recipe
--binary, -b Treat the source tree as something that should be rename Rename a recipe file in the workspace
installed verbatim (no compilation, same directory edit-recipe Edit a recipe file
structure). Useful with binary packages e.g. RPMs. find-recipe Find a recipe file
--also-native Also add native variant (i.e. support building configure-help Get help on configure script options
recipe for the build host as well as the target update-recipe Apply changes from external source tree to recipe
machine) reset Remove a recipe from your workspace
--src-subdir SUBDIR Specify subdirectory within source tree to use finish Finish working on a recipe in your workspace
--mirrors Enable PREMIRRORS and MIRRORS for source tree Testing changes on target:
fetching (disable by default). deploy-target Deploy recipe output files to live target machine
--provides PROVIDES, -p PROVIDES undeploy-target Undeploy recipe output files in live target machine
Specify an alias for the item provided by the build-image Build image including workspace recipe packages
recipe. E.g. virtual/libgl Advanced:
create-workspace Set up workspace in an alternative location
export Export workspace into a tar archive
import Import exported tar archive into workspace
extract Extract the source 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
</literallayout> </literallayout>
</para> </para>
@@ -97,9 +89,12 @@
name and using <filename>--help</filename>: name and using <filename>--help</filename>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool add --help $ devtool add --help
NOTE: Starting bitbake server...
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] [--fetch-dev] [--version VERSION] [--no-git]
[--also-native] [--src-subdir SUBDIR] [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH]
[--binary] [--also-native] [--src-subdir SUBDIR]
[--mirrors] [--provides PROVIDES]
[recipename] [srctree] [fetchuri] [recipename] [srctree] [fetchuri]
Adds a new recipe to the workspace to build a specified source tree. Can Adds a new recipe to the workspace to build a specified source tree. Can
@@ -123,18 +118,30 @@
--fetch URI, -f URI Fetch the specified URI and extract it to create the --fetch URI, -f URI Fetch the specified URI and extract it to create the
source tree (deprecated - pass as positional argument source tree (deprecated - pass as positional argument
instead) instead)
--fetch-dev For npm, also fetch devDependencies
--version VERSION, -V VERSION --version VERSION, -V VERSION
Version to use within recipe (PV) Version to use within recipe (PV)
--no-git, -g If fetching source, do not set up source tree as a git --no-git, -g If fetching source, do not set up source tree as a git
repository repository
--srcrev SRCREV, -S SRCREV
Source revision to fetch if fetching from an SCM such
as git (default latest)
--autorev, -a When fetching from a git repository, set SRCREV in the --autorev, -a When fetching from a git repository, set SRCREV in the
recipe to a floating revision instead of fixed recipe to a floating revision instead of fixed
--srcbranch SRCBRANCH, -B SRCBRANCH
Branch in source repository if fetching from an SCM
such as git (default master)
--binary, -b Treat the source tree as something that should be --binary, -b Treat the source tree as something that should be
installed verbatim (no compilation, same directory installed verbatim (no compilation, same directory
structure). Useful with binary packages e.g. RPMs. structure). Useful with binary packages e.g. RPMs.
--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
--mirrors Enable PREMIRRORS and MIRRORS for source tree fetching
(disable by default).
--provides PROVIDES, -p PROVIDES
Specify an alias for the item provided by the recipe.
E.g. virtual/libgl
</literallayout> </literallayout>
</para> </para>
</section> </section>
@@ -161,7 +168,7 @@
<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 must 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
run "devtool reset", devtool takes notice that the file has run "devtool reset", devtool takes notice that the file has