diff mbox series

doc/bitbake-user-manual-ref-variables: document BB_CONSOLE_LOG's persistence

Message ID 20260610-bb-console-log-persistent-v1-1-5430d24061c3@bootlin.com
State New
Headers show
Series doc/bitbake-user-manual-ref-variables: document BB_CONSOLE_LOG's persistence | expand

Commit Message

Antonin Godard June 10, 2026, 8:28 a.m. UTC
Changes to this variable only take effect after a server restart.
Document this behavior.

[YOCTO #15641]

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)


---
base-commit: c687d42b81b17e7a2399099cab0f1a6aafcf6520
change-id: 20260610-bb-console-log-persistent-c91ce341f898

Comments

Yoann Congal June 10, 2026, 10:08 a.m. UTC | #1
On Wed Jun 10, 2026 at 10:28 AM CEST, Antonin Godard wrote:
> Changes to this variable only take effect after a server restart.
> Document this behavior.
>
> [YOCTO #15641]
>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---

Looks good to me, thanks!

>  doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> index 9824b58ef27..f3e1a3a38c9 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -135,6 +135,16 @@ overview of their function and contents.
>        Specifies the path to a log file into which BitBake's user interface
>        writes output during the build.
>  
> +      This variable's value remains persistent during the entire execution of
> +      the BitBake server. Changes to this variable will only take effect
> +      after a server restart, which can be accomplished with the ``bitbake
> +      --kill-server`` command.
> +
> +      .. note::
> +
> +         For more details on how to make the BitBake server persistent, see the
> +         :term:`BB_SERVER_TIMEOUT` variable.
> +
>     :term:`BB_CURRENTTASK`
>        Contains the name of the currently running task. The name does not
>        include the ``do_`` prefix.
>
> ---
> base-commit: c687d42b81b17e7a2399099cab0f1a6aafcf6520
> change-id: 20260610-bb-console-log-persistent-c91ce341f898
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 9824b58ef27..f3e1a3a38c9 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -135,6 +135,16 @@  overview of their function and contents.
       Specifies the path to a log file into which BitBake's user interface
       writes output during the build.
 
+      This variable's value remains persistent during the entire execution of
+      the BitBake server. Changes to this variable will only take effect
+      after a server restart, which can be accomplished with the ``bitbake
+      --kill-server`` command.
+
+      .. note::
+
+         For more details on how to make the BitBake server persistent, see the
+         :term:`BB_SERVER_TIMEOUT` variable.
+
    :term:`BB_CURRENTTASK`
       Contains the name of the currently running task. The name does not
       include the ``do_`` prefix.