From b8bdd92ae648f4c94c4dfcd2f62aeffa1c2d0486 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 23 Sep 2013 13:42:02 -0700 Subject: [PATCH] ref-manual: Updated the bitbake --help listing. (From yocto-docs rev: 83f6776d107a146ff2bbcd37229e8cd637314fd9) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-bitbake.xml | 96 ++++++++++++------------ 1 file changed, 47 insertions(+), 49 deletions(-) diff --git a/documentation/ref-manual/ref-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml index 41e2601156..b587d46caa 100644 --- a/documentation/ref-manual/ref-bitbake.xml +++ b/documentation/ref-manual/ref-bitbake.xml @@ -23,7 +23,7 @@ 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. - BitBake just considers a list of tasks with dependencies and handles + BitBake just considers a list of tasks with dependencies and handles Metadata consisting of variables in a certain format that get passed to the tasks. @@ -320,76 +320,74 @@ $ 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. - It expects that BBFILES is defined, which is a space separated list of files to - be executed. BBFILES does support wildcards. - Default BBFILES are the .bb files in the current directory. + 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 which + will provide the layer, BBFILES and other configuration information. Options: --version show program's version number and exit -h, --help show this help message and exit -b BUILDFILE, --buildfile=BUILDFILE - execute the task against this .bb file, rather than a - package from BBFILES. Does not handle any - dependencies. - -k, --continue continue as much as possible after an error. While the - target that failed, and those that depend on it, - cannot be remade, the other dependencies of these - targets can be processed all the same. - -a, --tryaltconfigs continue with builds by trying to use alternative + Execute tasks from a specific .bb recipe directly. + WARNING: Does not handle any dependencies from other + recipes. + -k, --continue Continue as much as possible after an error. While the + target that failed and anything depending on it cannot + be built, as much as possible will be built before + stopping. + -a, --tryaltconfigs Continue with builds by trying to use alternative providers where possible. - -f, --force force run of specified cmd, regardless of stamp status - -c CMD, --cmd=CMD Specify task to execute. Note that this only executes - the specified task for the providee and the packages - it depends on, i.e. 'compile' does not implicitly call - stage for the dependencies (IOW: use only if you know - what you are doing). Depending on the base.bbclass a - listtasks tasks is defined and will show available - tasks + -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 cmd such as - 'compile' and run the default task for the specified - target(s) + Invalidate the stamp for the specified task such as + 'compile' and then run the default task for the + specified target(s). -r PREFILE, --read=PREFILE - read the specified file before bitbake.conf + Read the specified file before bitbake.conf. -R POSTFILE, --postread=POSTFILE - read the specified file after bitbake.conf - -v, --verbose output more chit-chat to the terminal + Read the specified file after bitbake.conf. + -v, --verbose Output more log message data to the terminal. -D, --debug Increase the debug level. You can specify this more 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 - don't execute, just dump out the signature - construction information - -p, --parse-only quit after parsing the BB files (developers only) - -s, --show-versions show current and preferred versions of all recipes - -e, --environment show the global or per-package environment (this is - what used to be bbread) - -g, --graphviz emit the dependency trees of the specified packages in - the dot syntax, and the pn-buildlist to show the build - list + Don't execute, just dump out the signature + construction information. + -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-package 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 print a report - -u UI, --ui=UI userinterface to use + -P, --profile Profile the command and save reports. + -u UI, --ui=UI The user interface to use (e.g. knotty, hob, depexp). -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 - floating revisions have changed or not - --server-only Run bitbake without UI, the frontend can connect with - bitbake server itself - -B BIND, --bind=BIND The name/address for the bitbake server to bind to - --no-setscene Do not run any setscene tasks, forces builds + 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 server to bind to. + --no-setscene Do not run any setscene tasks. sstate will be ignored + and everything needed, built. --remote-server=REMOTE_SERVER - Connect to the specified server - -m, --kill-server Terminate the remote server - --observe-only Connect to a server as an observing-only client + Connect to the specified server. + -m, --kill-server Terminate the remote server. + --observe-only Connect to a server as an observing-only client.