mbox series

[0/8] Encourage setting global changes in the proper place

Message ID 20260911-remove-local-conf-refs-v1-0-322e1e9a232d@bootlin.com
Headers show
Series Encourage setting global changes in the proper place | expand

Message

Antonin Godard Sept. 11, 2026, 3:11 p.m. UTC
The purpose of this series is change the current documentation to
encourage readers to make global configuration changes in the
appropriate place. Currently, the documentation mostly says "set X in
your local.conf" file - which works, but isn't ideal, as we have distro,
machine, and other configuration files available. We should encourage
users to create their own version of those, and version them in their
layers.

So, I went over each occurrence of "local.conf" I could find in the
documentation and tried to replace these kinds of suggestions by better
recommendations, e.g. set this in your distro/machine configuration
file. Sometimes, local.conf is actually a good recommendation (for local
modifications), so these occurrences were left as-is.

The series begins with improvements to the "Configuration File" term. As
this term is being heavily used afterwards, we need to redirect the
reader to the appropriate file, depending on the change being done.

The second to last patch is where most of the replacements occur. These
were hard to categorize as individual patches, so a big patch it is.

The last patch is slightly different: it replaces hardcoded paths of
configuration files to links to our structure.rst document, which has
explanations on what these files are meant for. This patch contains only
that. Hopefully this can help the reader understand the purpose of the
file given the context in which it is being referenced.

NOTE: this series was sent rebased on top of another one sent shortly
before: "Assorted fixes and additions" [1].

[1]: https://lore.kernel.org/r/20260911-assorted-fixes-v1-0-0d92a8112918@bootlin.com

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (8):
      ref-manual/terms.rst: Configuration File: precise machine conf files location
      ref-manual/terms.rst: Configuration File: split paragraph in a list
      ref-manual/terms.rst: Configuration File: use a link to local.conf
      ref-manual/classes.rst: buildstats: remove local.conf default value
      dev-manual/wic.rst: remove local.conf mentions
      ref-manual/variables.rst: GCCVERSION: replace local.conf and mention recipe existence
      docs-wide: advise setting global changes in the proper place
      docs-wide: replace hardcoded conf paths to structure.rst refs

 documentation/brief-yoctoprojectqs/index.rst       |   4 +-
 documentation/bsp-manual/bsp.rst                   |   6 +-
 documentation/dev-manual/bblock.rst                |   2 +-
 documentation/dev-manual/bmaptool.rst              |   5 +-
 documentation/dev-manual/build-quality.rst         |  15 +-
 documentation/dev-manual/building.rst              |  33 ++---
 documentation/dev-manual/custom-distribution.rst   |  14 +-
 .../custom-template-configuration-directory.rst    |   8 +-
 documentation/dev-manual/customizing-images.rst    |  11 +-
 documentation/dev-manual/debugging.rst             |  16 +--
 documentation/dev-manual/device-manager.rst        |   8 +-
 documentation/dev-manual/devtool.rst               |   4 +-
 documentation/dev-manual/disk-space.rst            |   2 +-
 .../dev-manual/efficiently-fetching-sources.rst    |   2 +-
 documentation/dev-manual/error-reporting-tool.rst  |   6 +-
 documentation/dev-manual/external-scm.rst          |   2 +-
 documentation/dev-manual/external-toolchain.rst    |   8 +-
 documentation/dev-manual/layers.rst                |  22 +--
 documentation/dev-manual/libraries.rst             |   7 +-
 documentation/dev-manual/licenses.rst              |  11 +-
 documentation/dev-manual/limiting-resources.rst    |   2 +-
 documentation/dev-manual/multiconfig.rst           |  10 +-
 documentation/dev-manual/new-recipe.rst            |   9 +-
 documentation/dev-manual/packages.rst              |  20 +--
 documentation/dev-manual/poky-manual-setup.rst     |   2 +-
 documentation/dev-manual/upgrading-recipes.rst     |  12 +-
 documentation/dev-manual/wayland.rst               |   4 +-
 documentation/dev-manual/wic.rst                   |   9 +-
 documentation/dev-manual/x32-psabi.rst             |   2 +-
 documentation/kernel-dev/common.rst                |  25 ++--
 documentation/migration-guides/migration-1.3.rst   |   4 +-
 documentation/migration-guides/migration-1.6.rst   |   6 +-
 documentation/migration-guides/migration-1.7.rst   |   4 +-
 documentation/migration-guides/migration-2.0.rst   |   2 +-
 documentation/migration-guides/migration-2.1.rst   |   2 +-
 documentation/migration-guides/migration-4.1.rst   |   2 +-
 documentation/migration-guides/migration-4.2.rst   |   4 +-
 .../migration-guides/release-notes-4.2.rst         |   2 +-
 .../migration-guides/release-notes-5.2.rst         |   2 +-
 .../migration-guides/release-notes-6.0.rst         |   2 +-
 documentation/overview-manual/concepts.rst         |  45 +++---
 documentation/profile-manual/intro.rst             |  12 +-
 documentation/profile-manual/usage.rst             |  15 +-
 documentation/ref-manual/classes.rst               |  30 ++--
 documentation/ref-manual/devtool-reference.rst     |   2 +-
 documentation/ref-manual/faq.rst                   |   8 +-
 documentation/ref-manual/images.rst                |   5 +-
 documentation/ref-manual/structure.rst             |  12 +-
 documentation/ref-manual/system-requirements.rst   |   2 +-
 documentation/ref-manual/terms.rst                 |  44 +++---
 documentation/ref-manual/variables.rst             | 158 ++++++++++-----------
 documentation/ref-manual/varlocality.rst           |   2 +-
 documentation/sdk-manual/appendix-customizing.rst  |   9 +-
 documentation/sdk-manual/appendix-obtain.rst       |  15 +-
 documentation/security-manual/read-only-rootfs.rst |   2 +-
 documentation/security-manual/securing-images.rst  |   6 +-
 documentation/test-manual/reproducible-builds.rst  |   6 +-
 documentation/test-manual/runtime-testing.rst      |  16 +--
 .../test-manual/understand-autobuilder.rst         |   4 +-
 documentation/toaster-manual/reference.rst         |   2 +-
 .../transitioning-to-a-custom-environment.rst      |   4 +-
 61 files changed, 367 insertions(+), 343 deletions(-)
---
base-commit: 670d4f143a899e3030f1dbde48d0e855b3b06521
change-id: 20260819-remove-local-conf-refs-92710803f267