[PATCH v4] bitbake-user-manual: Documenting BB_CMDLINE

[PATCH v4] bitbake-user-manual: Documenting BB_CMDLINE

[Swami]

Add documentation for the internal read-only variable :term:`BB_CMDLINE`.
Fixes [YOCTO #15746]
Signed-off-by: Swaminathan K <swami310@gmail.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++++
 1 file changed, 4 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 734c7858a..f49ce0f9f 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -116,6 +116,10 @@ overview of their function and contents.
       Specifies if SSL certificates should be checked when fetching. The default
       value is ``1`` and certificates are not checked if the value is set to ``0``.
 
+   :term:`BB_CMDLINE`
+        :term:`BB_CMDLINE` is an internal variable and is read-only. It captures the exact
+        command line used for the current invocation of BitBake.
+      
    :term:`BB_HASH_CODEPARSER_VALS`
       Specifies values for variables to use when populating the codeparser cache.
       This can be used selectively to set dummy values for variables to avoid

Re: [PATCH v4] bitbake-user-manual: Documenting BB_CMDLINE

[Michael Opdenacker]

Hi Swami

Thanks for the update and your patience :)

On 12/3/25 12:39, Swami wrote:
> Add documentation for the internal read-only variable :term:`BB_CMDLINE`.
> Fixes [YOCTO #15746]
> Signed-off-by: Swaminathan K <swami310@gmail.com>
> ---
>   doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++++
>   1 file changed, 4 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 734c7858a..f49ce0f9f 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -116,6 +116,10 @@ overview of their function and contents.
>         Specifies if SSL certificates should be checked when fetching. The default
>         value is ``1`` and certificates are not checked if the value is set to ``0``.
>   
> +   :term:`BB_CMDLINE`
> +        :term:`BB_CMDLINE` is an internal variable and is read-only. It captures the exact
> +        command line used for the current invocation of BitBake.
> +
>      :term:`BB_HASH_CODEPARSER_VALS`
>         Specifies values for variables to use when populating the codeparser cache.
>         This can be used selectively to set dummy values for variables to avoid


Looks all good to me.
Reviewed-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>

-- 
Michael Opdenacker
Root Commit
Yocto Project and OpenEmbedded Training course - Learn by doing:
https://rootcommit.com/training/yocto/

Re: [bitbake-devel] [PATCH v4] bitbake-user-manual: Documenting BB_CMDLINE

[Quentin Schulz]

Hi Swami,

On 12/3/25 12:39 PM, Swami via lists.openembedded.org wrote:
> [You don't often get email from swami310=gmail.com@lists.openembedded.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> Add documentation for the internal read-only variable :term:`BB_CMDLINE`.
> Fixes [YOCTO #15746]
> Signed-off-by: Swaminathan K <swami310@gmail.com>
> ---
>   doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++++
>   1 file changed, 4 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 734c7858a..f49ce0f9f 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -116,6 +116,10 @@ overview of their function and contents.
>         Specifies if SSL certificates should be checked when fetching. The default
>         value is ``1`` and certificates are not checked if the value is set to ``0``.
> 
> +   :term:`BB_CMDLINE`
> +        :term:`BB_CMDLINE` is an internal variable and is read-only. It captures the exact
> +        command line used for the current invocation of BitBake.
> +

This is inconsistent with the indentation on the rest of the file, we 
align with three whitespaces. So here the second and third line you're 
adding should have six whitespaces to start with and not eight like in 
this patch. Would be best to have it fixed, but the generated file isn't 
impacted by this, so not a blocker IMO.

The content makes sense to me after reading the code, so

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin