diff mbox series

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

Message ID 994b353e-5432-0b4e-4662-8f268483518a@crashcourse.ca
State Accepted
Headers show
Series overview-manual: inform the reader early of "bitbake-getvar" | expand

Commit Message

Robert P. J. Day May 19, 2026, 3:08 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 22, 2026, 2:42 p.m. UTC | #1
Hi,

On Tue May 19, 2026 at 5:04 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 ec5babe4c..0dac5cfbc 100644
> --- a/documentation/overview-manual/concepts.rst
> +++ b/documentation/overview-manual/concepts.rst
> @@ -11,6 +11,14 @@ workflow,
>  cross-development toolchains, shared state cache, and so forth are
>  explained.
>
> +.. note::
> +
> +   Throughout this section, many variables and their meanings are
> +   introduced. If, in the context of a build directory, you want to

We could s/build directory/:term:`Build Directory`/

> +   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
>  ========================

Thanks,
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 ec5babe4c..0dac5cfbc 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -11,6 +11,14 @@  workflow,
 cross-development toolchains, shared state cache, and so forth are
 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
+   ":ref:`dev-manual/debugging:viewing variable values`" section.
+
 Yocto Project Components
 ========================