diff mbox series

[v2] doc/logging: small clean-up and name environment

Message ID 6ab2ca1d7d9cd7ebf98aaca7e19612b3de0f133b.1737884847.git.joerg.sommer@navimatix.de
State New
Headers show
Series [v2] doc/logging: small clean-up and name environment | expand

Commit Message

Jörg Sommer Jan. 26, 2025, 9:47 a.m. UTC 
From: Jörg Sommer <joerg.sommer@navimatix.de>

The variable *BB_LOGCONFIG* is part of *BB_ENV_PASSTHROUGH_ADDITIONS* in
/scripts/oe-buildenv-internal and can therefore be passed as environment
variable.

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
---
 .../bitbake-user-manual-execution.rst                 | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Richard Purdie Jan. 26, 2025, 10:38 a.m. UTC | #1 
On Sun, 2025-01-26 at 10:47 +0100, Jörg Sommer via lists.yoctoproject.org wrote:
> From: Jörg Sommer <joerg.sommer@navimatix.de>
> 
> The variable *BB_LOGCONFIG* is part of *BB_ENV_PASSTHROUGH_ADDITIONS* in
> /scripts/oe-buildenv-internal and can therefore be passed as environment
> variable.

We have to be a little careful here since that script is in oe-core and
bitbake can be used with things that aren't oe-core and may not set
that.

> 
> -Then set the :term:`BB_LOGCONFIG` variable in ``conf/local.conf``::
> +Then set :term:`BB_LOGCONFIG` as an environment variable when running
> +BitBake, or set it in ``conf/local.conf``::
>  
>     BB_LOGCONFIG = "hashequiv.json"

We might need to document that it should be included in
BB_ENV_PASSTHROUGH_ADDITIONS. Perhaps making that a bitbake default
might be the easiest...

Cheers,

Richard
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-execution.rst b/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
index d58fbb32e..993dc3546 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
@@ -671,7 +671,7 @@  logging configuration is merged using the following rules:
 
 -  Any keys defined in the ``handlers``, ``formatters``, or ``filters``,
    will be merged into the same section in the default configuration,
-   with the user specified keys taking replacing a default one if there
+   with the user specified keys replacing a default one if there
    is a conflict. In practice, this means that if both the default
    configuration and user configuration specify a handler named
    ``myhandler``, the user defined one will replace the default. To
@@ -707,9 +707,9 @@  or higher priority to a file called ``hashequiv.log``::
            }
        },
        "formatters": {
-               "logfileFormatter": {
-                   "format": "%(name)s: %(levelname)s: %(message)s"
-               }
+           "logfileFormatter": {
+               "format": "%(name)s: %(levelname)s: %(message)s"
+           }
        },
        "loggers": {
            "BitBake.SigGen.HashEquiv": {
@@ -723,7 +723,8 @@  or higher priority to a file called ``hashequiv.log``::
        }
    }
 
-Then set the :term:`BB_LOGCONFIG` variable in ``conf/local.conf``::
+Then set :term:`BB_LOGCONFIG` as an environment variable when running
+BitBake, or set it in ``conf/local.conf``::
 
    BB_LOGCONFIG = "hashequiv.json"