summaryrefslogtreecommitdiffstats
path: root/bitbake
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake')
-rw-r--r--bitbake/doc/user-manual/user-manual-intro.xml141
1 files changed, 71 insertions, 70 deletions
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index c7f01ad726..cd05fc5d07 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -434,76 +434,77 @@
434 Following is the usage and syntax for BitBake: 434 Following is the usage and syntax for BitBake:
435 <literallayout class='monospaced'> 435 <literallayout class='monospaced'>
436 $ bitbake -h 436 $ bitbake -h
437Usage: bitbake [options] [recipename/target ...] 437 Usage: bitbake [options] [recipename/target ...]
438 438
439 Executes the specified task (default is 'build') for a given set of target recipes (.bb files). 439 Executes the specified task (default is 'build') for a given set of target recipes (.bb files).
440 It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which 440 It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which
441 will provide the layer, BBFILES and other configuration information. 441 will provide the layer, BBFILES and other configuration information.
442 442
443Options: 443 Options:
444 --version show program's version number and exit 444 --version show program's version number and exit
445 -h, --help show this help message and exit 445 -h, --help show this help message and exit
446 -b BUILDFILE, --buildfile=BUILDFILE 446 -b BUILDFILE, --buildfile=BUILDFILE
447 Execute tasks from a specific .bb recipe directly. 447 Execute tasks from a specific .bb recipe directly.
448 WARNING: Does not handle any dependencies from other 448 WARNING: Does not handle any dependencies from other
449 recipes. 449 recipes.
450 -k, --continue Continue as much as possible after an error. While the 450 -k, --continue Continue as much as possible after an error. While the
451 target that failed and anything depending on it cannot 451 target that failed and anything depending on it cannot
452 be built, as much as possible will be built before 452 be built, as much as possible will be built before
453 stopping. 453 stopping.
454 -a, --tryaltconfigs Continue with builds by trying to use alternative 454 -a, --tryaltconfigs Continue with builds by trying to use alternative
455 providers where possible. 455 providers where possible.
456 -f, --force Force the specified targets/task to run (invalidating 456 -f, --force Force the specified targets/task to run (invalidating
457 any existing stamp file). 457 any existing stamp file).
458 -c CMD, --cmd=CMD Specify the task to execute. The exact options 458 -c CMD, --cmd=CMD Specify the task to execute. The exact options
459 available depend on the metadata. Some examples might 459 available depend on the metadata. Some examples might
460 be 'compile' or 'populate_sysroot' or 'listtasks' may 460 be 'compile' or 'populate_sysroot' or 'listtasks' may
461 give a list of the tasks available. 461 give a list of the tasks available.
462 -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP 462 -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP
463 Invalidate the stamp for the specified task such as 463 Invalidate the stamp for the specified task such as
464 'compile' and then run the default task for the 464 'compile' and then run the default task for the
465 specified target(s). 465 specified target(s).
466 -r PREFILE, --read=PREFILE 466 -r PREFILE, --read=PREFILE
467 Read the specified file before bitbake.conf. 467 Read the specified file before bitbake.conf.
468 -R POSTFILE, --postread=POSTFILE 468 -R POSTFILE, --postread=POSTFILE
469 Read the specified file after bitbake.conf. 469 Read the specified file after bitbake.conf.
470 -v, --verbose Output more log message data to the terminal. 470 -v, --verbose Output more log message data to the terminal.
471 -D, --debug Increase the debug level. You can specify this more 471 -D, --debug Increase the debug level. You can specify this more
472 than once. 472 than once.
473 -n, --dry-run Don't execute, just go through the motions. 473 -n, --dry-run Don't execute, just go through the motions.
474 -S, --dump-signatures 474 -S DUMP_SIGNATURES, --dump-signatures=DUMP_SIGNATURES
475 Don't execute, just dump out the signature 475 Dump out the signature construction information, with
476 construction information. 476 no task execution. Parameters are passed to the
477 -p, --parse-only Quit after parsing the BB recipes. 477 signature handling code, use 'none' if no specific
478 -s, --show-versions Show current and preferred versions of all recipes. 478 handler is required.
479 -e, --environment Show the global or per-package environment complete 479 -p, --parse-only Quit after parsing the BB recipes.
480 with information about where variables were 480 -s, --show-versions Show current and preferred versions of all recipes.
481 set/changed. 481 -e, --environment Show the global or per-package environment complete
482 -g, --graphviz Save dependency tree information for the specified 482 with information about where variables were
483 targets in the dot syntax. 483 set/changed.
484 -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED 484 -g, --graphviz Save dependency tree information for the specified
485 Assume these dependencies don't exist and are already 485 targets in the dot syntax.
486 provided (equivalent to ASSUME_PROVIDED). Useful to 486 -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
487 make dependency graphs more appealing 487 Assume these dependencies don't exist and are already
488 -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS 488 provided (equivalent to ASSUME_PROVIDED). Useful to
489 Show debug logging for the specified logging domains 489 make dependency graphs more appealing
490 -P, --profile Profile the command and save reports. 490 -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS
491 -u UI, --ui=UI The user interface to use (e.g. knotty, hob, depexp). 491 Show debug logging for the specified logging domains
492 -t SERVERTYPE, --servertype=SERVERTYPE 492 -P, --profile Profile the command and save reports.
493 Choose which server to use, process or xmlrpc. 493 -u UI, --ui=UI The user interface to use (e.g. knotty, hob, depexp).
494 --revisions-changed Set the exit code depending on whether upstream 494 -t SERVERTYPE, --servertype=SERVERTYPE
495 floating revisions have changed or not. 495 Choose which server to use, process or xmlrpc.
496 --server-only Run bitbake without a UI, only starting a server 496 --revisions-changed Set the exit code depending on whether upstream
497 (cooker) process. 497 floating revisions have changed or not.
498 -B BIND, --bind=BIND The name/address for the bitbake server to bind to. 498 --server-only Run bitbake without a UI, only starting a server
499 --no-setscene Do not run any setscene tasks. sstate will be ignored 499 (cooker) process.
500 and everything needed, built. 500 -B BIND, --bind=BIND The name/address for the bitbake server to bind to.
501 --remote-server=REMOTE_SERVER 501 --no-setscene Do not run any setscene tasks. sstate will be ignored
502 Connect to the specified server. 502 and everything needed, built.
503 -m, --kill-server Terminate the remote server. 503 --remote-server=REMOTE_SERVER
504 --observe-only Connect to a server as an observing-only client. 504 Connect to the specified server.
505 --status-only Check the status of the remote bitbake server. 505 -m, --kill-server Terminate the remote server.
506 506 --observe-only Connect to a server as an observing-only client.
507 --status-only Check the status of the remote bitbake server.
507 </literallayout> 508 </literallayout>
508 </para> 509 </para>
509 </section> 510 </section>