From 00d09f8fd42d153faa3d035393ad5d65f6b17b7e Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Wed, 29 Oct 2025 18:42:42 +0100 Subject: [PATCH] dev-manual: debugging: use bitbake-getvar in Viewing Variable Values section We should recommend using bitbake-getvar command wherever possible as its output is much less confusing and overwhelming than bitbake -e. Unfortunately, bitbake-getvar currently doesn't list Python tasks or functions, unlike bitbake -e, so keep the latter for some corner cases. [AG: Moroever -> Moreover typo fix] (From yocto-docs rev: 3f1ca1c3ef60dfabe5b2a2c6e53d14edad64fb06) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 41e4e05369c4e028c679749b7b62434327927a09) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/dev-manual/debugging.rst | 34 +++++++++++++++----------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 8552b26aea..434c026b74 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst @@ -111,17 +111,17 @@ occurred in your project. Perhaps an attempt to :ref:`modify a variable ` did not work out as expected. -BitBake's ``-e`` option is used to display variable values after -parsing. The following command displays the variable values after the -configuration files (i.e. ``local.conf``, ``bblayers.conf``, +BitBake's ``bitbake-getvar`` command is used to display variable values after +parsing. The following command displays the variable value for :term:`OVERRIDES` +after the configuration files (i.e. ``local.conf``, ``bblayers.conf``, ``bitbake.conf`` and so forth) have been parsed:: - $ bitbake -e + $ bitbake-getvar OVERRIDES -The following command displays variable values after a specific recipe has -been parsed. The variables include those from the configuration as well:: +The following command displays the value of :term:`PV` after a specific recipe +has been parsed:: - $ bitbake -e recipename + $ bitbake-getvar -r recipename PV .. note:: @@ -135,19 +135,25 @@ been parsed. The variables include those from the configuration as well:: the recipe datastore, which means that variables set within one task will not be visible to other tasks. -In the output of ``bitbake -e``, each variable is preceded by a -description of how the variable got its value, including temporary -values that were later overridden. This description also includes -variable flags (varflags) set on the variable. The output can be very +In the output of ``bitbake-getvar``, the line containing the value of the +variable is preceded by a description of how the variable got its value, +including temporary values that were later overridden. This description also +includes variable flags (varflags) set on the variable. The output can be very helpful during debugging. Variables that are exported to the environment are preceded by -``export`` in the output of ``bitbake -e``. See the following example:: +``export`` in the output of ``bitbake-getvar``. See the following example:: export CC="i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/ulf/poky/build/tmp/sysroots/qemux86" -In addition to variable values, the output of the ``bitbake -e`` and -``bitbake -e`` recipe commands includes the following information: +Shell functions and tasks can also be inspected with the same mechanism:: + + $ bitbake-getvar -r recipename do_install + +For Python functions and tasks, ``bitbake -e recipename`` can be used instead. + +Moreover, the output of the ``bitbake -e`` and ``bitbake -e`` recipe commands +includes the following information: - The output starts with a tree listing all configuration files and classes included globally, recursively listing the files they include