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

[PATCH v5] 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..00b28519a 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 v5] bitbake-user-manual: Documenting BB_CMDLINE

[Michael Opdenacker]

Hi Swani

Thanks for the update!

On 12/4/25 01:25, 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..00b28519a 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.
> +


Oops, you have unnecessary spaces in your last line. Please remove them. 
My editor flags those and this is distracting for a reviewer.
Unless Antonin prefers to fix this by himself.

If you send a V6, you can also move "the exact" to the next line. 
Otherwise, your line is longer than 80
characters and it also stands out a little bit.

Sorry, documentation patches are the most difficult ones 😅
Thanks for your patience!
Cheers
Michael.

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

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

[Swami]

[-- Attachment #1: Type: text/plain, Size: 2317 bytes --]

Thanks Michael,
I will do the changes and submit a new patch.
I picked up documentation assuming it would be easy :)
Many thanks to you,Antonin, for bearing with my endless patches for such a
small change.
On the positive side, I am getting comfortable with the steps by this
repetition.
Unfortunately , that is adding to much back and forth
Hope I can nail it with the next patch.

regards
Swami

On Thu, Dec 4, 2025 at 4:24 PM Michael Opdenacker <
michael.opdenacker@rootcommit.com> wrote:

> Hi Swani
>
> Thanks for the update!
>
> On 12/4/25 01:25, 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..00b28519a 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.
> > +
>
>
> Oops, you have unnecessary spaces in your last line. Please remove them.
> My editor flags those and this is distracting for a reviewer.
> Unless Antonin prefers to fix this by himself.
>
> If you send a V6, you can also move "the exact" to the next line.
> Otherwise, your line is longer than 80
> characters and it also stands out a little bit.
>
> Sorry, documentation patches are the most difficult ones 😅
> Thanks for your patience!
> Cheers
> Michael.
>
> --
> Michael Opdenacker
> Root Commit
> Yocto Project and OpenEmbedded Training course - Learn by doing:
> https://rootcommit.com/training/yocto/
>
>

[-- Attachment #2: Type: text/html, Size: 3047 bytes --]

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

[Antonin Godard]

Hi Swani,

On Thu Dec 4, 2025 at 12:19 PM CET, Swami via lists.openembedded.org wrote:
> Thanks Michael,
> I will do the changes and submit a new patch.
> I picked up documentation assuming it would be easy :)
> Many thanks to you,Antonin, for bearing with my endless patches for such a
> small change.
> On the positive side, I am getting comfortable with the steps by this
> repetition.
> Unfortunately , that is adding to much back and forth
> Hope I can nail it with the next patch.

No problem, that's part of the learning process and once that's settled in,
you'll have less and less iterations on patches. :) We are happy to welcome new
contributors.

I can also suggest b4 which does makes things a bit easier to manage patches:
https://b4.docs.kernel.org/en/latest/

I can't make the modifications locally though, as I don't merge things on the
bitbake (only yocto-docs). Please send a new version of the patch, that's fine!

Thank you,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com