diff mbox series

[4/4] doc/bitbake-user-manual-intro.rst: refresh bitbake's help message

Message ID 20261013-warn-as-errors-v1-4-ab3658758ceb@bootlin.com
State New
Headers show
Series Add -W to treat warnings as errors | expand

Commit Message

Antonin Godard Oct. 13, 2026, 12:13 p.m. UTC
Refresh the bitbake help message with all recent changes.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 .../bitbake-user-manual-intro.rst                  | 36 ++++++++++++----------
 1 file changed, 20 insertions(+), 16 deletions(-)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
index 6801323e2fb..af6dfed8915 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
@@ -415,8 +415,8 @@  Following is the usage and syntax for BitBake::
    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]
+                  [-k] [-P PROFILE] [-S SIGNATURE_HANDLER] [--revisions-changed]
+                  [-b BUILDFILE] [-D] [-l DEBUG_DOMAINS] [-v] [-q] [-W]
                   [-w WRITEEVENTLOG] [-B BIND] [-T SERVER_TIMEOUT]
                   [--remote-server REMOTE_SERVER] [-m] [--token XMLRPCTOKEN]
                   [--observe-only] [--status-only] [--server-only] [-r PREFILE]
@@ -435,7 +435,7 @@  Following is the usage and syntax for BitBake::
                            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,
+     -u, --ui UI           The user interface to use (knotty, ncurses,
                            taskexp_ncurses or teamcity - default knotty).
      --version             Show programs version and exit.
      -h, --help            Show this help message and exit.
@@ -443,11 +443,11 @@  Following is the usage and syntax for BitBake::
    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
+     -c, --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
+     -C, --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).
@@ -471,8 +471,11 @@  Following is the usage and syntax for BitBake::
                            target that failed and anything depending on it cannot
                            be built, as much as possible will be built before
                            stopping.
-     -P, --profile         Profile the command and save reports.
-     -S SIGNATURE_HANDLER, --dump-signatures SIGNATURE_HANDLER
+     -P, --profile PROFILE
+                           Profile the command and save reports. Specify 'main',
+                           'idle' or 'parsing' to indicate which bitbake code to
+                           profile.
+     -S, --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
@@ -484,7 +487,7 @@  Following is the usage and syntax for BitBake::
                            expected)
      --revisions-changed   Set the exit code depending on whether upstream
                            floating revisions have changed or not.
-     -b BUILDFILE, --buildfile BUILDFILE
+     -b, --buildfile BUILDFILE
                            Execute tasks from a specific .bb recipe directly.
                            WARNING: Does not handle any dependencies from other
                            recipes.
@@ -499,22 +502,24 @@  Following is the usage and syntax for BitBake::
                            -D only affects output to stdout. All debug messages
                            are written to ${T}/log.do_taskname, regardless of the
                            debug level.
-     -l DEBUG_DOMAINS, --log-domains DEBUG_DOMAINS
+     -l, --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
                            specify this more than once.
-     -w WRITEEVENTLOG, --write-log WRITEEVENTLOG
+     -W, --warnings-as-errors
+                           Treat warnings as errors.
+     -w, --write-log WRITEEVENTLOG
                            Writes the event log of the build to a bitbake event
                            json file. Use '' (empty string) to assign the name
                            automatically.
 
    Server options:
-     -B BIND, --bind BIND  The name/address for the bitbake xmlrpc server to bind
+     -B, --bind BIND       The name/address for the bitbake xmlrpc server to bind
                            to.
-     -T SERVER_TIMEOUT, --idle-timeout SERVER_TIMEOUT
+     -T, --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.
@@ -529,11 +534,10 @@  Following is the usage and syntax for BitBake::
                            (cooker) process.
 
    Configuration options:
-     -r PREFILE, --read PREFILE
-                           Read the specified file before bitbake.conf.
-     -R POSTFILE, --postread POSTFILE
+     -r, --read PREFILE    Read the specified file before bitbake.conf.
+     -R, --postread POSTFILE
                            Read the specified file after bitbake.conf.
-     -I EXTRA_ASSUME_PROVIDED, --ignore-deps EXTRA_ASSUME_PROVIDED
+     -I, --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.