From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>,
Quentin Schulz <quentin.schulz@cherry.de>
Subject: [PATCH v3 0/6] Document missing toolchain related variables
Date: Thu, 27 Mar 2025 10:07:25 +0100 [thread overview]
Message-ID: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> (raw)
Document a bunch a toolchain related variables. These follow a naming
scheme to make them easier to deduce from the name. Try clearing this
out for users reading the documentation.
Fixes https://bugzilla.yoctoproject.org/show_bug.cgi?id=15719.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v3:
- Review by Quentin (thank you!):
- Include section number for manpage links.
- For BUILD_* variables, be more precise about the fact that we should
not override it from recipes but we can sometimes use them to refer
to a host tool from a target recipe context.
- Link to v2: https://lore.kernel.org/r/20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com
Changes in v2:
- Add a patch to define a manpage url, for giving manpage links in the
docs.
- Reformulate the BUILD_* definitions to explicitely say that we are not
supposed to set these variables or use them directly in recipes.
- Link to v1: https://lore.kernel.org/r/20250317-cc-vars-v1-0-25edbadfd054@bootlin.com
---
Antonin Godard (6):
documentation/conf.py: define a manpage url
ref-manual/variables.rst: add manpage links for toolchain variables
ref-manual/variables.rst: add missing documentation for BUILD_* variables
ref-manual/variables.rst: document missing SDK_*_ARCH variables
ref-manual/variables.rst: document HOST_*_ARCH variables
ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference
documentation/conf.py | 3 +
documentation/overview-manual/concepts.rst | 2 +-
documentation/overview-manual/yp-intro.rst | 2 +-
documentation/ref-manual/variables.rst | 319 ++++++++++++++++++++++++++---
4 files changed, 291 insertions(+), 35 deletions(-)
---
base-commit: ee6b3698da044e290dbc4fbb852f3cc37638e689
change-id: 20250317-cc-vars-e2cd2076a3a6
Best regards,
--
Antonin Godard <antonin.godard@bootlin.com>
next reply other threads:[~2025-03-27 9:07 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-27 9:07 Antonin Godard [this message]
2025-03-27 9:07 ` [PATCH v3 1/6] documentation/conf.py: define a manpage url Antonin Godard
2025-03-27 15:35 ` [docs] " Mark Hatle
2025-03-31 15:01 ` Antonin Godard
2025-03-28 13:21 ` Quentin Schulz
2025-03-27 9:07 ` [PATCH v3 2/6] ref-manual/variables.rst: add manpage links for toolchain variables Antonin Godard
2025-03-28 13:23 ` [docs] " Quentin Schulz
2025-03-27 9:07 ` [PATCH v3 3/6] ref-manual/variables.rst: add missing documentation for BUILD_* variables Antonin Godard
2025-03-28 13:43 ` [docs] " Quentin Schulz
2025-03-27 9:07 ` [PATCH v3 4/6] ref-manual/variables.rst: document missing SDK_*_ARCH variables Antonin Godard
2025-03-27 9:07 ` [PATCH v3 5/6] ref-manual/variables.rst: document HOST_*_ARCH variables Antonin Godard
2025-03-27 9:07 ` [PATCH v3 6/6] ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference Antonin Godard
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=20250327-cc-vars-v3-0-742dbddce008@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@cherry.de \
--cc=thomas.petazzoni@bootlin.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.