mirror of
https://git.yoctoproject.org/poky
synced 2026-02-10 02:33:02 +01:00
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>
This commit is contained in:
Scott Rifenbark
committed by
Richard Purdie
Richard Purdie
parent
51347f576a
commit
7e87668bee
@@ -35,59 +35,51 @@
|
||||
the commands:
|
||||
<literallayout class='monospaced'>
|
||||
$ devtool --help
|
||||
usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI]
|
||||
[--fetch-dev] [--version VERSION] [--no-git]
|
||||
[--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH]
|
||||
[--binary] [--also-native] [--src-subdir SUBDIR]
|
||||
[--mirrors] [--provides PROVIDES]
|
||||
[recipename] [srctree] [fetchuri]
|
||||
NOTE: Starting bitbake server...
|
||||
usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q]
|
||||
[--color COLOR] [-h]
|
||||
<subcommand> ...
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
OpenEmbedded development tool
|
||||
|
||||
options:
|
||||
-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 (deprecated - pass as positional
|
||||
argument instead)
|
||||
--fetch-dev For npm, also fetch devDependencies
|
||||
--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
|
||||
--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 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
|
||||
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)
|
||||
--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
|
||||
--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:
|
||||
Beginning work on a recipe:
|
||||
add Add a new recipe
|
||||
modify Modify the source for an existing recipe
|
||||
upgrade Upgrade an existing recipe
|
||||
Getting information:
|
||||
status Show workspace status
|
||||
search Search available recipes
|
||||
latest-version Report the latest version of an existing recipe
|
||||
Working on a recipe in the workspace:
|
||||
build Build a recipe
|
||||
rename Rename a recipe file in the workspace
|
||||
edit-recipe Edit a recipe file
|
||||
find-recipe Find a recipe file
|
||||
configure-help Get help on configure script options
|
||||
update-recipe Apply changes from external source tree to recipe
|
||||
reset Remove a recipe from your workspace
|
||||
finish Finish working on a recipe in your workspace
|
||||
Testing changes on target:
|
||||
deploy-target Deploy recipe output files to live target machine
|
||||
undeploy-target Undeploy recipe output files in live target machine
|
||||
build-image Build image including workspace recipe packages
|
||||
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 <subcommand> --help to get help on a specific command
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
@@ -97,9 +89,12 @@
|
||||
name and using <filename>--help</filename>:
|
||||
<literallayout class='monospaced'>
|
||||
$ devtool add --help
|
||||
NOTE: Starting bitbake server...
|
||||
usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI]
|
||||
[--version VERSION] [--no-git] [--autorev] [--binary]
|
||||
[--also-native] [--src-subdir SUBDIR]
|
||||
[--fetch-dev] [--version VERSION] [--no-git]
|
||||
[--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH]
|
||||
[--binary] [--also-native] [--src-subdir SUBDIR]
|
||||
[--mirrors] [--provides PROVIDES]
|
||||
[recipename] [srctree] [fetchuri]
|
||||
|
||||
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
|
||||
source tree (deprecated - pass as positional argument
|
||||
instead)
|
||||
--fetch-dev For npm, also fetch devDependencies
|
||||
--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
|
||||
--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
|
||||
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
|
||||
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)
|
||||
--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>
|
||||
</para>
|
||||
</section>
|
||||
@@ -161,7 +168,7 @@
|
||||
|
||||
<para>
|
||||
<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
|
||||
run "devtool add", make changes to the recipe, and then
|
||||
run "devtool reset", devtool takes notice that the file has
|
||||
|
||||
Reference in New Issue
Block a user