ref-manual: Updated the bitbake --help listing.

(From yocto-docs rev: 83f6776d107a146ff2bbcd37229e8cd637314fd9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-09-23 13:42:02 -07:00 committed by Richard Purdie
parent 7fa2c8f6f7
commit b8bdd92ae6
1 changed files with 47 additions and 49 deletions

View File

@ -23,7 +23,7 @@
<note> <note>
BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships. BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships.
As such, it has no real knowledge of what the tasks being executed actually do. As such, it has no real knowledge of what the tasks being executed actually do.
BitBake just considers a list of tasks with dependencies and handles BitBake just considers a list of tasks with dependencies and handles
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
consisting of variables in a certain format that get passed to the tasks. consisting of variables in a certain format that get passed to the tasks.
</note> </note>
@ -320,76 +320,74 @@
<screen> <screen>
$ bitbake --help $ bitbake --help
Usage: bitbake [options] [package ...] Usage: bitbake [options] [recipename/target ...]
Executes the specified task (default is 'build') for a given set of BitBake files. Executes the specified task (default is 'build') for a given set of target recipes (.bb files).
It expects that BBFILES is defined, which is a space separated list of files to It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which
be executed. BBFILES does support wildcards. will provide the layer, BBFILES and other configuration information.
Default BBFILES are the .bb files in the current directory.
Options: Options:
--version show program's version number and exit --version show program's version number and exit
-h, --help show this help message and exit -h, --help show this help message and exit
-b BUILDFILE, --buildfile=BUILDFILE -b BUILDFILE, --buildfile=BUILDFILE
execute the task against this .bb file, rather than a Execute tasks from a specific .bb recipe directly.
package from BBFILES. Does not handle any WARNING: Does not handle any dependencies from other
dependencies. 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 those that depend on it, target that failed and anything depending on it cannot
cannot be remade, the other dependencies of these be built, as much as possible will be built before
targets can be processed all the same. stopping.
-a, --tryaltconfigs continue with builds by trying to use alternative -a, --tryaltconfigs Continue with builds by trying to use alternative
providers where possible. providers where possible.
-f, --force force run of specified cmd, regardless of stamp status -f, --force Force the specified targets/task to run (invalidating
-c CMD, --cmd=CMD Specify task to execute. Note that this only executes any existing stamp file).
the specified task for the providee and the packages -c CMD, --cmd=CMD Specify the task to execute. The exact options
it depends on, i.e. 'compile' does not implicitly call available depend on the metadata. Some examples might
stage for the dependencies (IOW: use only if you know be 'compile' or 'populate_sysroot' or 'listtasks' may
what you are doing). Depending on the base.bbclass a give a list of the tasks available.
listtasks tasks is defined and will show available
tasks
-C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP
Invalidate the stamp for the specified cmd such as Invalidate the stamp for the specified task such as
'compile' and run the default task for the specified 'compile' and then run the default task for the
target(s) specified target(s).
-r PREFILE, --read=PREFILE -r PREFILE, --read=PREFILE
read the specified file before bitbake.conf Read the specified file before bitbake.conf.
-R POSTFILE, --postread=POSTFILE -R POSTFILE, --postread=POSTFILE
read the specified file after bitbake.conf Read the specified file after bitbake.conf.
-v, --verbose output more chit-chat to the terminal -v, --verbose Output more log message data to the terminal.
-D, --debug Increase the debug level. You can specify this more -D, --debug Increase the debug level. You can specify this more
than once. than once.
-n, --dry-run don't execute, just go through the motions -n, --dry-run Don't execute, just go through the motions.
-S, --dump-signatures -S, --dump-signatures
don't execute, just dump out the signature Don't execute, just dump out the signature
construction information construction information.
-p, --parse-only quit after parsing the BB files (developers only) -p, --parse-only Quit after parsing the BB recipes.
-s, --show-versions show current and preferred versions of all recipes -s, --show-versions Show current and preferred versions of all recipes.
-e, --environment show the global or per-package environment (this is -e, --environment Show the global or per-package environment complete
what used to be bbread) with information about where variables were
-g, --graphviz emit the dependency trees of the specified packages in set/changed.
the dot syntax, and the pn-buildlist to show the build -g, --graphviz Save dependency tree information for the specified
list targets in the dot syntax.
-I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
Assume these dependencies don't exist and are already Assume these dependencies don't exist and are already
provided (equivalent to ASSUME_PROVIDED). Useful to provided (equivalent to ASSUME_PROVIDED). Useful to
make dependency graphs more appealing make dependency graphs more appealing
-l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS
Show debug logging for the specified logging domains Show debug logging for the specified logging domains
-P, --profile profile the command and print a report -P, --profile Profile the command and save reports.
-u UI, --ui=UI userinterface to use -u UI, --ui=UI The user interface to use (e.g. knotty, hob, depexp).
-t SERVERTYPE, --servertype=SERVERTYPE -t SERVERTYPE, --servertype=SERVERTYPE
Choose which server to use, process or xmlrpc Choose which server to use, process or xmlrpc.
--revisions-changed Set the exit code depending on whether upstream --revisions-changed Set the exit code depending on whether upstream
floating revisions have changed or not floating revisions have changed or not.
--server-only Run bitbake without UI, the frontend can connect with --server-only Run bitbake without a UI, only starting a server
bitbake server itself (cooker) process.
-B BIND, --bind=BIND The name/address for the bitbake server to bind to -B BIND, --bind=BIND The name/address for the bitbake server to bind to.
--no-setscene Do not run any setscene tasks, forces builds --no-setscene Do not run any setscene tasks. sstate will be ignored
and everything needed, built.
--remote-server=REMOTE_SERVER --remote-server=REMOTE_SERVER
Connect to the specified server Connect to the specified server.
-m, --kill-server Terminate the remote server -m, --kill-server Terminate the remote server.
--observe-only Connect to a server as an observing-only client --observe-only Connect to a server as an observing-only client.
</screen> </screen>
</section> </section>