diff mbox series

Documenting BB_CMDLINE

Message ID 20251202073141.16223-1-swami310@gmail.com
State New
Headers show
Series Documenting BB_CMDLINE | expand

Commit Message

Swami Dec. 2, 2025, 7:31 a.m. UTC
Signed-off-by: Swaminathan K <swami310@gmail.com>
Upstream-Status: Submitted
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Antonin Godard Dec. 2, 2025, 4:42 p.m. UTC | #1
Hi Swaminathan K,

Thanks for the patch, I'm glad you were able to find out how to send your patch.

On Tue Dec 2, 2025 at 8:31 AM CET, Swami via lists.openembedded.org wrote:
> Signed-off-by: Swaminathan K <swami310@gmail.com>

Please write a commit message body, even if it's short sentence.

Also include the bug number ID in the commit message body:

"""
Fixes [YOCTO #15746]
"""

> Upstream-Status: Submitted

No need to include the Upstream-Status here. This must be included for patches
applied to recipes in OpenEmbedded-Core (e.g. https://git.openembedded.org/openembedded-core/tree/meta/recipes-support/numactl/numactl/0001-define-run-test-target.patch#n6).

I guess the contributor guide might be confusing regarding this point, so I will
try to make clearer.

> ---
>  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..5e14e40b4 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`
> +        BB_CMDLINE is an internal variable and is read-only. It captures the exact

Please wrap BB_CMDLINE with :term:, like this:

"""
:term:`BB_CMDLINE` is an internal...
"""

> +        command line used for the current invocation of bitbake 

s/bitbake/BitBake/

Otherwise, the sentence is missing a period, and has a trailing whitespace.

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..5e14e40b4 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`
+        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