diff mbox series

[v2] overview-manual: inform the reader early of "bitbake-getvar"

Message ID f4adc33f-5b48-bd89-e872-fa387921aa2d@crashcourse.ca
State Accepted
Headers show
Series [v2] overview-manual: inform the reader early of "bitbake-getvar" | expand

Commit Message

Robert P. J. Day May 22, 2026, 4:38 p.m. UTC
Given how Chapter 4 of the Overview Manual introduces so many of the
variables that define a build, briefly introduce the reader to the
"bitbake-getvar" command so they can examine those variables.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Comments

Antonin Godard May 26, 2026, 7:52 a.m. UTC | #1
On Fri May 22, 2026 at 6:35 PM CEST, Robert P. J. Day wrote:
>
> Given how Chapter 4 of the Overview Manual introduces so many of the
> variables that define a build, briefly introduce the reader to the
> "bitbake-getvar" command so they can examine those variables.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
> index 0dac5cfbc..5c6df883a 100644
> --- a/documentation/overview-manual/concepts.rst
> +++ b/documentation/overview-manual/concepts.rst
> @@ -14,9 +14,9 @@ explained.
>  .. note::
>
>     Throughout this section, many variables and their meanings are
> -   introduced. If, in the context of a build directory, you want to
> -   examine the value of any of these variables, you can use the
> -   ``bitbake-getvar`` command, explained in the
> +   introduced. If, in the context of a :term:`Build Directory`,
> +   you want to examine the value of any of these variables, you can
> +   use the ``bitbake-getvar`` command, explained in the
>     ":ref:`dev-manual/debugging:viewing variable values`" section.
>
>  Yocto Project Components

You sent this but it is based on your v1. I squashed this one and v1 locally,
just wanted to let you know.

Antonin
Antonin Godard June 9, 2026, 7:27 a.m. UTC | #2
Applied, thanks!

[1/1] overview-manual: inform the reader early of "bitbake-getvar"
      commit: 33f57d154ad1ec950c59c5aab20e0a0323ef19cc
diff mbox series

Patch

diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 0dac5cfbc..5c6df883a 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -14,9 +14,9 @@  explained.
 .. note::

    Throughout this section, many variables and their meanings are
-   introduced. If, in the context of a build directory, you want to
-   examine the value of any of these variables, you can use the
-   ``bitbake-getvar`` command, explained in the
+   introduced. If, in the context of a :term:`Build Directory`,
+   you want to examine the value of any of these variables, you can
+   use the ``bitbake-getvar`` command, explained in the
    ":ref:`dev-manual/debugging:viewing variable values`" section.

 Yocto Project Components