From: Michael Opdenacker <michael.opdenacker@bootlin.com>
To: "Simone Weiß" <simone.p.weiss@posteo.com>
Cc: docs@lists.yoctoproject.org, bitbake-devel@lists.openembedded.org
Subject: Re: [docs] [PATCH v2] bitbake: doc: Add section for variable context
Date: Mon, 19 Feb 2024 19:44:44 +0100 [thread overview]
Message-ID: <192680d9-bb72-44ab-84cd-40972ba78417@bootlin.com> (raw)
In-Reply-To: <20240217110704.49901-1-simone.p.weiss@posteo.com>
Hi Simone,
Many thanks for the updates!
On 2/17/24 at 12:07, Simone Weiß wrote:
> From: Simone Weiß <simone.p.weiss@posteo.com>
>
> This is inspired by the same section in the yocto-docs. It aims to provide
> information in what contexts(recipes, .conf, bbclass,...) a variable is usually
> used. For that I tried to group similar variables, so that a short overview is
> given. This was inspired by [YOCTO #14072], but of course does not implement a
> warning if a variable is used in an unintended context.
>
> Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
> ---
> ...bake-user-manual-ref-variables-context.rst | 89 +++++++++++++++++++
> doc/index.rst | 1 +
> 2 files changed, 90 insertions(+)
> create mode 100644 doc/bitbake-user-manual/bitbake-user-manual-ref-variables-context.rst
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables-context.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables-context.rst
> new file mode 100644
> index 00000000..8252889e
> --- /dev/null
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables-context.rst
> @@ -0,0 +1,89 @@
> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Oops, I overlooked this. The license doesn't match the one in the other
documents. I'm not sure this matters though...
> +
> +****************
> +Variable Context
> +****************
Oops, another issue: your section doesn't appear in the top left menu,
and when I look at it, it doesn't have any numbering.
I guess this happens because you didn't start your section with the same
headers as the other documents.
Using the same headers as in the previous document fixes the trouble:
================
Variable Context
================
....
BitBake's own configuration
===========================
> +
> +Variables might only have an impact or can be used in certain contexts. Some
> +should only be used in global files like ``.conf``, while others are intended only
> +for local files like ``.bb``. This chapter aims to describe some important variable
> +contexts.
> +
> +.. _ref-varcontext-configuration:
Why this anchor? Do you plan to make references to it elsewhere? Just to
double check...
Cheers
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
next prev parent reply other threads:[~2024-02-19 18:44 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-17 11:07 [PATCH v2] bitbake: doc: Add section for variable context simone.p.weiss
2024-02-19 18:44 ` Michael Opdenacker [this message]
[not found] <17B4A1C770848659.28679@lists.yoctoproject.org>
2024-02-17 23:16 ` [docs] " Simone Weiß
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=192680d9-bb72-44ab-84cd-40972ba78417@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=bitbake-devel@lists.openembedded.org \
--cc=docs@lists.yoctoproject.org \
--cc=simone.p.weiss@posteo.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).