diff options
Diffstat (limited to 'bitbake')
-rw-r--r-- | bitbake/doc/user-manual/user-manual-bitbakecommand.xml | 98 |
1 files changed, 60 insertions, 38 deletions
diff --git a/bitbake/doc/user-manual/user-manual-bitbakecommand.xml b/bitbake/doc/user-manual/user-manual-bitbakecommand.xml index 119c89299f..3cf779b12c 100644 --- a/bitbake/doc/user-manual/user-manual-bitbakecommand.xml +++ b/bitbake/doc/user-manual/user-manual-bitbakecommand.xml | |||
@@ -11,53 +11,75 @@ | |||
11 | <title>Usage and syntax</title> | 11 | <title>Usage and syntax</title> |
12 | <para> | 12 | <para> |
13 | <screen><prompt>$ </prompt>bitbake --help | 13 | <screen><prompt>$ </prompt>bitbake --help |
14 | usage: bitbake [options] [package ...] | 14 | Usage: bitbake [options] [recipename/target ...] |
15 | 15 | ||
16 | Executes the specified task (default is 'build') for a given set of BitBake files. | 16 | Executes the specified task (default is 'build') for a given set of target recipes (.bb files). |
17 | It expects that BBFILES is defined, which is a space separated list of files to | 17 | It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which |
18 | be executed. BBFILES does support wildcards. | 18 | will provide the layer, BBFILES and other configuration information. |
19 | Default BBFILES are the .bb files in the current directory. | ||
20 | 19 | ||
21 | options: | 20 | Options: |
22 | --version show program's version number and exit | 21 | --version show program's version number and exit |
23 | -h, --help show this help message and exit | 22 | -h, --help show this help message and exit |
24 | -b BUILDFILE, --buildfile=BUILDFILE | 23 | -b BUILDFILE, --buildfile=BUILDFILE |
25 | execute the task against this .bb file, rather than a | 24 | Execute tasks from a specific .bb recipe directly. |
26 | package from BBFILES. | 25 | WARNING: Does not handle any dependencies from other |
27 | -k, --continue continue as much as possible after an error. While the | 26 | recipes. |
28 | target that failed, and those that depend on it, | 27 | -k, --continue Continue as much as possible after an error. While the |
29 | cannot be remade, the other dependencies of these | 28 | target that failed and anything depending on it cannot |
30 | targets can be processed all the same. | 29 | be built, as much as possible will be built before |
31 | -f, --force force run of specified cmd, regardless of stamp status | 30 | stopping. |
32 | -i, --interactive drop into the interactive mode also called the BitBake | 31 | -a, --tryaltconfigs Continue with builds by trying to use alternative |
33 | shell. | 32 | providers where possible. |
34 | -c CMD, --cmd=CMD Specify task to execute. Note that this only executes | 33 | -f, --force Force the specified targets/task to run (invalidating |
35 | the specified task for the providee and the packages | 34 | any existing stamp file). |
36 | it depends on, i.e. 'compile' does not implicitly call | 35 | -c CMD, --cmd=CMD Specify the task to execute. The exact options |
37 | stage for the dependencies (IOW: use only if you know | 36 | available depend on the metadata. Some examples might |
38 | what you are doing). Depending on the base.bbclass a | 37 | be 'compile' or 'populate_sysroot' or 'listtasks' may |
39 | listtasks task is defined and will show available | 38 | give a list of the tasks available. |
40 | tasks | 39 | -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP |
41 | -r FILE, --read=FILE read the specified file before bitbake.conf | 40 | Invalidate the stamp for the specified task such as |
42 | -v, --verbose output more chit-chat to the terminal | 41 | 'compile' and then run the default task for the |
42 | specified target(s). | ||
43 | -r PREFILE, --read=PREFILE | ||
44 | Read the specified file before bitbake.conf. | ||
45 | -R POSTFILE, --postread=POSTFILE | ||
46 | Read the specified file after bitbake.conf. | ||
47 | -v, --verbose Output more log message data to the terminal. | ||
43 | -D, --debug Increase the debug level. You can specify this more | 48 | -D, --debug Increase the debug level. You can specify this more |
44 | than once. | 49 | than once. |
45 | -n, --dry-run don't execute, just go through the motions | 50 | -n, --dry-run Don't execute, just go through the motions. |
46 | -p, --parse-only quit after parsing the BB files (developers only) | 51 | -S, --dump-signatures |
47 | -s, --show-versions show current and preferred versions of all packages | 52 | Don't execute, just dump out the signature |
48 | -e, --environment show the global or per-package environment (this is | 53 | construction information. |
49 | what used to be bbread) | 54 | -p, --parse-only Quit after parsing the BB recipes. |
50 | -g, --graphviz emit the dependency trees of the specified packages in | 55 | -s, --show-versions Show current and preferred versions of all recipes. |
51 | the dot syntax | 56 | -e, --environment Show the global or per-package environment complete |
52 | -I IGNORED_DOT_DEPS, --ignore-deps=IGNORED_DOT_DEPS | 57 | with information about where variables were |
53 | Stop processing at the given list of dependencies when | 58 | set/changed. |
54 | generating dependency graphs. This can help to make | 59 | -g, --graphviz Save dependency tree information for the specified |
55 | the graph more appealing | 60 | targets in the dot syntax. |
61 | -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED | ||
62 | Assume these dependencies don't exist and are already | ||
63 | provided (equivalent to ASSUME_PROVIDED). Useful to | ||
64 | make dependency graphs more appealing | ||
56 | -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS | 65 | -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS |
57 | Show debug logging for the specified logging domains | 66 | Show debug logging for the specified logging domains |
58 | -P, --profile profile the command and print a report | 67 | -P, --profile Profile the command and save reports. |
59 | 68 | -u UI, --ui=UI The user interface to use (e.g. knotty, hob, depexp). | |
60 | 69 | -t SERVERTYPE, --servertype=SERVERTYPE | |
70 | Choose which server to use, process or xmlrpc. | ||
71 | --revisions-changed Set the exit code depending on whether upstream | ||
72 | floating revisions have changed or not. | ||
73 | --server-only Run bitbake without a UI, only starting a server | ||
74 | (cooker) process. | ||
75 | -B BIND, --bind=BIND The name/address for the bitbake server to bind to. | ||
76 | --no-setscene Do not run any setscene tasks. sstate will be ignored | ||
77 | and everything needed, built. | ||
78 | --remote-server=REMOTE_SERVER | ||
79 | Connect to the specified server. | ||
80 | -m, --kill-server Terminate the remote server. | ||
81 | --observe-only Connect to a server as an observing-only client. | ||
82 | --status-only Check the status of the remote bitbake server. | ||
61 | </screen> | 83 | </screen> |
62 | </para> | 84 | </para> |
63 | <para> | 85 | <para> |