diff mbox series

bitbake-user-manual: Documenting BB_CMDLINE Add documentation for the internal read-only variable :term:'BB_CMDLINE'. Fixes [Yocto #15746] Signed-off-by: Swaminathan K <swami310@gmail.com>

Message ID 20251203012343.15709-1-swami310@gmail.com
State New
Headers show
Series bitbake-user-manual: Documenting BB_CMDLINE Add documentation for the internal read-only variable :term:'BB_CMDLINE'. Fixes [Yocto #15746] Signed-off-by: Swaminathan K <swami310@gmail.com> | expand

Commit Message

Swami Dec. 3, 2025, 1:23 a.m. UTC
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Antonin Godard Dec. 3, 2025, 8:15 a.m. UTC | #1
Hi,

It looks like your commit message body went in the subject of your patch. Please
resend with this fixed. Perhaps send it to yourself first before the mailing
list, to make sure the formatting is correct.

Please put the bug ID in capital: [YOCTO #15746], as shown in the
contributor guide.

Please include that this is a v2 of the patch: read
https://docs.yoctoproject.org/contributor-guide/submit-changes.html#taking-patch-review-into-account.
So next will be v3.

On Wed Dec 3, 2025 at 2:23 AM CET, Swami via lists.openembedded.org wrote:
> ---
>  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..f756c436d 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

:term:`BB_CMDLINE` with backticks here, not :term:'BB_CMDLINE'. We compile
documentation with Sphinx and this is how Sphinx understands that this is a
cross-reference.

Also missing a space: "read-only.It" -> "read-only. It"

> +        command line used for the current invocation of BitBake.
> +      

Please remove spurious whitespaces here.

>     :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

Thanks,
Antonin
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..f756c436d 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