diff mbox series

[v6] bitbake-user-manual: Documenting BB_CMDLINE

Message ID 20251204234240.7224-1-swami310@gmail.com
State New
Headers show
Series [v6] bitbake-user-manual: Documenting BB_CMDLINE | expand

Commit Message

Swami Dec. 4, 2025, 11:42 p.m. UTC
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(+)

Comments

Antonin Godard Dec. 5, 2025, 7:49 a.m. UTC | #1
On Fri Dec 5, 2025 at 12:42 AM CET, Swami via lists.openembedded.org 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..32860ec0c 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

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin
Peter Kjellerstedt Dec. 5, 2025, 2:59 p.m. UTC | #2
> -----Original Message-----
> From: bitbake-devel@lists.openembedded.org <bitbake-devel@lists.openembedded.org> On Behalf Of Swami via lists.openembedded.org
> Sent: den 5 december 2025 00:43
> To: bitbake-devel@lists.openembedded.org; docs@lists.yoctoproject.org
> Cc: michael.opdenacker@rootcommit.com; Swami <swami310@gmail.com>
> Subject: [bitbake-devel] [PATCH v6] bitbake-user-manual: Documenting BB_CMDLINE

Change "Documenting" to "Document".

> 
> Add documentation for the internal read-only variable :term:`BB_CMDLINE`.
> Fixes [YOCTO #15746]
> Signed-off-by: Swaminathan K <swami310@gmail.com>

Git trailers (like Signed-off-by above) are expected to be separated from 
the rest of the body by an empty line. I would also suggest adding an 
empty line before the Fixes line.

> ---
>  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..32860ec0c 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

//Peter
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 734c7858a..32860ec0c 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