mbox series

[v4,0/6] Document missing toolchain related variables

Message ID 20250331-cc-vars-v4-0-2281f4c47652@bootlin.com
Headers show
Series Document missing toolchain related variables | expand

Message

Antonin Godard March 31, 2025, 3:04 p.m. UTC 
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 v4:
- Reviews by Quentin (thanks!):
  - Rephrase link to update-rc.d.
  - Typo in conf.py.
  - Bad definition of BUILD_AS fixed.
- Link to v3: https://lore.kernel.org/r/20250327-cc-vars-v3-0-742dbddce008@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     | 318 ++++++++++++++++++++++++++---
 4 files changed, 290 insertions(+), 35 deletions(-)
---
base-commit: 0e538c102bfcb7184c76c2401e8cb878168c4434
change-id: 20250317-cc-vars-e2cd2076a3a6

Best regards,