MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

bitbake: doc/user-manual: Refresh help output

Browse Source 
In commit 9257c48c3e36 ("Group and reorder options in bitbake help"),
help output was changed, update the doc to match the new output.

(Bitbake rev: 7ef357f1c6fcd50c9d22190ba39d1cfd82070c79)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Yoann Congal 2024-10-18 23:36:26 +02:00 committed by Richard Purdie
parent b9b59b5a8b
commit 2abc5dd028
1 changed files with 108 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
View File

@ -349,40 +349,84 @@ Usage and syntax
Following is the usage and syntax for BitBake:: Following is the usage and syntax for BitBake::
$ bitbake -h $ bitbake -h
Usage: bitbake [options] [recipename/target recipe:do_task ...] usage: bitbake [-s] [-e] [-g] [-u UI] [--version] [-h] [-f] [-c CMD]
[-C INVALIDATE_STAMP] [--runall RUNALL] [--runonly RUNONLY]
[--no-setscene] [--skip-setscene] [--setscene-only] [-n] [-p]
[-k] [-P] [-S SIGNATURE_HANDLER] [--revisions-changed]
[-b BUILDFILE] [-D] [-l DEBUG_DOMAINS] [-v] [-q]
[-w WRITEEVENTLOG] [-B BIND] [-T SERVER_TIMEOUT]
[--remote-server REMOTE_SERVER] [-m] [--token XMLRPCTOKEN]
[--observe-only] [--status-only] [--server-only] [-r PREFILE]
[-R POSTFILE] [-I EXTRA_ASSUME_PROVIDED]
[recipename/target ...]
Executes the specified task (default is 'build') for a given set of target recipes (.bb files). It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH
It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which which will provide the layer, BBFILES and other configuration information.
will provide the layer, BBFILES and other configuration information.
Options: General options:
--version show program's version number and exit recipename/target Execute the specified task (default is 'build') for
-h, --help show this help message and exit these target recipes (.bb files).
-b BUILDFILE, --buildfile=BUILDFILE -s, --show-versions Show current and preferred versions of all recipes.
Execute tasks from a specific .bb recipe directly. -e, --environment Show the global or per-recipe environment complete
WARNING: Does not handle any dependencies from other with information about where variables were
recipes. set/changed.
-g, --graphviz Save dependency tree information for the specified
targets in the dot syntax.
-u UI, --ui UI The user interface to use (knotty, ncurses, taskexp,
taskexp_ncurses or teamcity - default knotty).
--version Show programs version and exit.
-h, --help Show this help message and exit.
Task control options:
-f, --force Force the specified targets/task to run (invalidating
any existing stamp file).
-c CMD, --cmd CMD Specify the task to execute. The exact options
available depend on the metadata. Some examples might
be 'compile' or 'populate_sysroot' or 'listtasks' may
give a list of the tasks available.
-C INVALIDATE_STAMP, --clear-stamp INVALIDATE_STAMP
Invalidate the stamp for the specified task such as
'compile' and then run the default task for the
specified target(s).
--runall RUNALL Run the specified task for any recipe in the taskgraph
of the specified target (even if it wouldn't otherwise
have run).
--runonly RUNONLY Run only the specified task within the taskgraph of
the specified targets (and any task dependencies those
tasks may have).
--no-setscene Do not run any setscene tasks. sstate will be ignored
and everything needed, built.
--skip-setscene Skip setscene tasks if they would be executed. Tasks
previously restored from sstate will be kept, unlike
--no-setscene.
--setscene-only Only run setscene tasks, don't run any real tasks.
Execution control options:
-n, --dry-run Don't execute, just go through the motions.
-p, --parse-only Quit after parsing the BB recipes.
-k, --continue Continue as much as possible after an error. While the -k, --continue Continue as much as possible after an error. While the
target that failed and anything depending on it cannot target that failed and anything depending on it cannot
be built, as much as possible will be built before be built, as much as possible will be built before
stopping. stopping.
-f, --force Force the specified targets/task to run (invalidating -P, --profile Profile the command and save reports.
any existing stamp file). -S SIGNATURE_HANDLER, --dump-signatures SIGNATURE_HANDLER
-c CMD, --cmd=CMD Specify the task to execute. The exact options Dump out the signature construction information, with
available depend on the metadata. Some examples might no task execution. The SIGNATURE_HANDLER parameter is
be 'compile' or 'populate_sysroot' or 'listtasks' may passed to the handler. Two common values are none and
give a list of the tasks available. printdiff but the handler may define more/less. none
-C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP means only dump the signature, printdiff means
Invalidate the stamp for the specified task such as recursively compare the dumped signature with the most
'compile' and then run the default task for the recent one in a local build or sstate cache (can be
specified target(s). used to find out why tasks re-run when that is not
-r PREFILE, --read=PREFILE expected)
Read the specified file before bitbake.conf. --revisions-changed Set the exit code depending on whether upstream
-R POSTFILE, --postread=POSTFILE floating revisions have changed or not.
Read the specified file after bitbake.conf. -b BUILDFILE, --buildfile BUILDFILE
-v, --verbose Enable tracing of shell tasks (with 'set -x'). Also Execute tasks from a specific .bb recipe directly.
print bb.note(...) messages to stdout (in addition to WARNING: Does not handle any dependencies from other
writing them to ${T}/log.do_&lt;task&gt;). recipes.
Logging/output control options:
-D, --debug Increase the debug level. You can specify this more -D, --debug Increase the debug level. You can specify this more
than once. -D sets the debug level to 1, where only than once. -D sets the debug level to 1, where only
bb.debug(1, ...) messages are printed to stdout; -DD bb.debug(1, ...) messages are printed to stdout; -DD
@ -392,65 +436,47 @@ Following is the usage and syntax for BitBake::
-D only affects output to stdout. All debug messages -D only affects output to stdout. All debug messages
are written to ${T}/log.do_taskname, regardless of the are written to ${T}/log.do_taskname, regardless of the
debug level. debug level.
-l DEBUG_DOMAINS, --log-domains DEBUG_DOMAINS
Show debug logging for the specified logging domains.
-v, --verbose Enable tracing of shell tasks (with 'set -x'). Also
print bb.note(...) messages to stdout (in addition to
writing them to ${T}/log.do_<task>).
-q, --quiet Output less log message data to the terminal. You can -q, --quiet Output less log message data to the terminal. You can
specify this more than once. specify this more than once.
-n, --dry-run Don't execute, just go through the motions. -w WRITEEVENTLOG, --write-log WRITEEVENTLOG
-S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
Dump out the signature construction information, with
no task execution. The SIGNATURE_HANDLER parameter is
passed to the handler. Two common values are none and
printdiff but the handler may define more/less. none
means only dump the signature, printdiff means compare
the dumped signature with the cached one.
-p, --parse-only Quit after parsing the BB recipes.
-s, --show-versions Show current and preferred versions of all recipes.
-e, --environment Show the global or per-recipe environment complete
with information about where variables were
set/changed.
-g, --graphviz Save dependency tree information for the specified
targets in the dot syntax.
-I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
Assume these dependencies don't exist and are already
provided (equivalent to ASSUME_PROVIDED). Useful to
make dependency graphs more appealing
-l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS
Show debug logging for the specified logging domains
-P, --profile Profile the command and save reports.
-u UI, --ui=UI The user interface to use (knotty, ncurses, taskexp or
teamcity - default knotty).
--token=XMLRPCTOKEN Specify the connection token to be used when
connecting to a remote server.
--revisions-changed Set the exit code depending on whether upstream
floating revisions have changed or not.
--server-only Run bitbake without a UI, only starting a server
(cooker) process.
-B BIND, --bind=BIND The name/address for the bitbake xmlrpc server to bind
to.
-T SERVER_TIMEOUT, --idle-timeout=SERVER_TIMEOUT
Set timeout to unload bitbake server due to
inactivity, set to -1 means no unload, default:
Environment variable BB_SERVER_TIMEOUT.
--no-setscene Do not run any setscene tasks. sstate will be ignored
and everything needed, built.
--skip-setscene Skip setscene tasks if they would be executed. Tasks
previously restored from sstate will be kept, unlike
--no-setscene
--setscene-only Only run setscene tasks, don't run any real tasks.
--remote-server=REMOTE_SERVER
Connect to the specified server.
-m, --kill-server Terminate any running bitbake server.
--observe-only Connect to a server as an observing-only client.
--status-only Check the status of the remote bitbake server.
-w WRITEEVENTLOG, --write-log=WRITEEVENTLOG
Writes the event log of the build to a bitbake event Writes the event log of the build to a bitbake event
json file. Use '' (empty string) to assign the name json file. Use '' (empty string) to assign the name
automatically. automatically.
--runall=RUNALL Run the specified task for any recipe in the taskgraph
of the specified target (even if it wouldn't otherwise Server options:
have run). -B BIND, --bind BIND The name/address for the bitbake xmlrpc server to bind
--runonly=RUNONLY Run only the specified task within the taskgraph of to.
the specified targets (and any task dependencies those -T SERVER_TIMEOUT, --idle-timeout SERVER_TIMEOUT
tasks may have). Set timeout to unload bitbake server due to
inactivity, set to -1 means no unload, default:
Environment variable BB_SERVER_TIMEOUT.
--remote-server REMOTE_SERVER
Connect to the specified server.
-m, --kill-server Terminate any running bitbake server.
--token XMLRPCTOKEN Specify the connection token to be used when
connecting to a remote server.
--observe-only Connect to a server as an observing-only client.
--status-only Check the status of the remote bitbake server.
--server-only Run bitbake without a UI, only starting a server
(cooker) process.
Configuration options:
-r PREFILE, --read PREFILE
Read the specified file before bitbake.conf.
-R POSTFILE, --postread POSTFILE
Read the specified file after bitbake.conf.
-I EXTRA_ASSUME_PROVIDED, --ignore-deps EXTRA_ASSUME_PROVIDED
Assume these dependencies don't exist and are already
provided (equivalent to ASSUME_PROVIDED). Useful to
make dependency graphs more appealing.
..
Bitbake help output generated with "stty columns 80; bin/bitbake -h"
.. _bitbake-examples: .. _bitbake-examples: