mbox series

[v2,0/5] documentation: minor fixes, plus a confusables check

Message ID 20260728072328.11926-1-niko.mauno@vaisala.com
Headers show
Series documentation: minor fixes, plus a confusables check | expand

Message

Niko Mauno July 28, 2026, 7:23 a.m. UTC 
From: Niko Mauno <niko.mauno@vaisala.com>

A small collection of documentation fixes. Several correct example
snippets that misbehave when copied verbatim; the last two remove
non-ASCII "confusable" characters and add a check to keep them out.

  * ref-manual: add the trailing space missing from :prepend examples,
    so readers don't risk inadvertent string concatenation.
  * ref-manual: drop superfluous spaces from :append examples.
  * dev-manual: add the whitespace around '=' that the Whinlatter
    (5.3) recipe parser now warns about.
  * documentation: replace non-ASCII confusables (curly quotes, en/em
    dashes, ellipsis, non-breaking and zero-width spaces) with ASCII;
    e.g. a curly quote copied into a recipe causes a bitbake
    ParseError. Legitimate non-ASCII (box-drawing in directory trees,
    accented contributor names, CJK) is left untouched.
  * tools: add the check-confusables script and wire it up as a
    pre-commit hook and in the Makefile "checks" target, in the same
    fashion as check-glossaries, to guard against regressions.

Changes since v1:
  * Squashed the two confusable cleanups (recipe-style-guide and
    identify-component) into a single documentation-wide patch and
    extended it to all remaining occurrences (24 files, not 2).
  * Added the check-confusables tool, pre-commit hook and Makefile
    integration.
  * The three whitespace/operator fixes are unchanged from v1.

Niko Mauno (5):
  ref-manual: Fix occurrences of omitted space with :prepend
  ref-manual: Prune superfluous space with :append
  dev-manual: Fix missing whitespace around '=' operator
  documentation: Replace non-ASCII confusable characters with ASCII
  tools: Add check-confusables pre-commit hook

 .pre-commit-config.yaml                       |  5 ++
 documentation/Makefile                        |  1 +
 .../contributor-guide/identify-component.rst  |  4 +-
 documentation/contributor-guide/index.rst     |  4 +-
 .../contributor-guide/recipe-style-guide.rst  |  8 +-
 .../contributor-guide/submit-changes.rst      |  4 +-
 documentation/dev-manual/build-quality.rst    |  2 +-
 .../dev-manual/creating-fragments.rst         | 18 ++---
 documentation/dev-manual/debugging.rst        | 14 ++--
 documentation/dev-manual/layers.rst           |  2 +-
 documentation/dev-manual/new-recipe.rst       |  4 +-
 .../dev-manual/prebuilt-libraries.rst         | 28 +++----
 documentation/kernel-dev/common.rst           | 10 +--
 .../migration-guides/release-notes-4.1.rst    | 22 +++---
 .../migration-guides/release-notes-5.0.rst    | 12 +--
 .../migration-guides/release-notes-5.1.rst    | 16 ++--
 .../migration-guides/release-notes-5.2.rst    | 40 +++++-----
 .../migration-guides/release-notes-5.3.rst    | 42 +++++-----
 .../migration-guides/release-notes-6.0.rst    | 44 +++++------
 documentation/ref-manual/classes.rst          |  4 +-
 .../ref-manual/devtool-reference.rst          |  4 +-
 documentation/ref-manual/faq.rst              |  6 +-
 documentation/ref-manual/qa-checks.rst        |  2 +-
 documentation/ref-manual/structure.rst        | 14 ++--
 documentation/ref-manual/variables.rst        |  7 +-
 .../yocto-project-supported-features.rst      | 10 +--
 .../test-manual/yocto-project-compatible.rst  |  2 +-
 documentation/tools/check-confusables         | 77 +++++++++++++++++++
 .../transitioning-to-a-custom-environment.rst |  2 +-
 documentation/what-i-wish-id-known.rst        | 14 ++--
 30 files changed, 254 insertions(+), 168 deletions(-)
 create mode 100755 documentation/tools/check-confusables


base-commit: 358519ca6406a89fee42c45dcaf63a37a374f33c