docs: highlight BitBake snippets with the bitbake language
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest10 patches 22 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/10 | ref-manual/variables.rst: use the bitbake code-block languagedocumentation/ | +1226 | 0 replies | |
| 2/10 | ref-manual: use the bitbake code-block languagedocumentation/ documentation/ documentation/ +3 more | +183 | 0 replies | |
| 3/10 | dev-manual: use the bitbake code-block languagedocumentation/ documentation/ documentation/ +32 more | +522 | 0 replies | |
| 4/10 | migration-guides: use the bitbake code-block languagedocumentation/ documentation/ documentation/ +24 more | +236 | 0 replies | |
| 5/10 | kernel-dev: use the bitbake code-block languagedocumentation/ documentation/ documentation/ | +108 | 0 replies | |
| 6/10 | test-manual: use the bitbake code-block languagedocumentation/ documentation/ documentation/ +1 more | +66 | 0 replies | |
| 7/10 | overview-manual: use the bitbake code-block languagedocumentation/ | +51 | 0 replies | |
| 8/10 | security-manual: use the bitbake code-block languagedocumentation/ documentation/ documentation/ +1 more | +48 | 0 replies | |
| 9/10 | sdk-manual: use the bitbake code-block languagedocumentation/ documentation/ | +11 | 0 replies | |
| 10/10 | docs-wide: use the bitbake code-block languagedocumentation/ documentation/ documentation/ +1 more | +54 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
Cover letter [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language
Pygments 2.21.0 added a BitBake lexer, so BitBake snippets can now say what they are instead of rendering as plain literal blocks. This tags the ones in yocto-docs.
One patch per manual, which is also roughly one reviewable unit per patch. No prose changes, no reflowing, no reindenting - every hunk turns a literal-block introducer into a code-block directive and nothing else.
Which blocks were converted was decided by reading, not by pattern matching. Blocks that share BitBake's assignment shape but are another language were left alone: a Makefile, Django settings, an Automake fragment, a wic kickstart include, kernel .scc metadata, U-Boot Image Tree Source. So were blocks an author had deliberately marked "none", which usually means "this is not purely code" rather than "nobody got round to it".
Please do not apply this yet
----------------------------
The autobuilder builds the docs with a pinned buildtools tarball that currently carries Pygments 2.19.2, which predates the BitBake lexer. run-docs-build also passes SPHINXOPTS="-j auto", dropping the -W the Makefile defaults to, so on that toolchain every one of these blocks would publish unhighlighted and the build would still succeed. I have asked separately about refreshing that tarball.
Sending now for review rather than to be merged. Once the toolchain can render it, this applies as-is.
Depends on
----------
"docs: state the language of nine literal blocks explicitly", sent separately, which gives some non-BitBake blocks their correct language. That patch stands on its own and can go in independently; this series is based on it only so the two do not touch the same lines.
Not included
------------
Six blocks in ref-manual/ trip a defect in the released BitBake lexer, fixed upstream but not yet in a release. They are a separate patch, held until that release, so the rest is not blocked behind them.
Trevor Woerner (10):
ref-manual/variables.rst: use the bitbake code-block language
ref-manual: use the bitbake code-block language
dev-manual: use the bitbake code-block language
migration-guides: use the bitbake code-block language
kernel-dev: use the bitbake code-block language
test-manual: use the bitbake code-block language
overview-manual: use the bitbake code-block language
security-manual: use the bitbake code-block language
sdk-manual: use the bitbake code-block language
docs-wide: use the bitbake code-block language
documentation/brief-yoctoprojectqs/index.rst | 4 +- documentation/bsp-manual/bsp.rst | 28 +- .../contributor-guide/recipe-style-guide.rst | 24 +- documentation/dev-manual/bblock.rst | 4 +- documentation/dev-manual/bmaptool.rst | 4 +- documentation/dev-manual/build-quality.rst | 8 +- documentation/dev-manual/building.rst | 44 +- .../dev-manual/creating-fragments.rst | 6 +- .../dev-manual/custom-distribution.rst | 4 +- .../dev-manual/customizing-images.rst | 32 +- documentation/dev-manual/debugging.rst | 40 +- documentation/dev-manual/device-manager.rst | 12 +- documentation/dev-manual/devtool.rst | 8 +- documentation/dev-manual/disk-space.rst | 4 +- .../dev-manual/error-reporting-tool.rst | 12 +- documentation/dev-manual/external-scm.rst | 20 +- .../dev-manual/gobject-introspection.rst | 12 +- documentation/dev-manual/hashequivserver.rst | 12 +- documentation/dev-manual/init-manager.rst | 16 +- documentation/dev-manual/layers.rst | 56 +- documentation/dev-manual/libraries.rst | 12 +- documentation/dev-manual/licenses.rst | 60 +- .../dev-manual/limiting-resources.rst | 4 +- documentation/dev-manual/multiconfig.rst | 40 +- documentation/dev-manual/new-machine.rst | 4 +- documentation/dev-manual/new-recipe.rst | 160 +- documentation/dev-manual/packages.rst | 44 +- .../dev-manual/poky-manual-setup.rst | 4 +- .../dev-manual/prebuilt-libraries.rst | 12 +- documentation/dev-manual/qemu.rst | 4 +- documentation/dev-manual/quilt.rst | 4 +- documentation/dev-manual/sbom.rst | 4 +- .../dev-manual/speeding-up-build.rst | 4 +- .../dev-manual/sstate-mirrors-setup.rst | 16 +- .../dev-manual/temporary-source-code.rst | 8 +- .../dev-manual/upgrading-recipes.rst | 12 +- documentation/dev-manual/wayland.rst | 8 +- documentation/dev-manual/x32-psabi.rst | 4 +- documentation/kernel-dev/advanced.rst | 48 +- documentation/kernel-dev/common.rst | 88 +- documentation/kernel-dev/faq.rst | 8 +- .../migration-guides/migration-1.3.rst | 8 +- .../migration-guides/migration-1.6.rst | 12 +- .../migration-guides/migration-1.7.rst | 4 +- .../migration-guides/migration-1.8.rst | 12 +- .../migration-guides/migration-2.0.rst | 8 +- .../migration-guides/migration-2.1.rst | 4 +- .../migration-guides/migration-2.2.rst | 11 +- .../migration-guides/migration-2.3.rst | 12 +- .../migration-guides/migration-2.5.rst | 4 +- .../migration-guides/migration-2.6.rst | 12 +- .../migration-guides/migration-3.0.rst | 4 +- .../migration-guides/migration-3.1.rst | 12 +- .../migration-guides/migration-3.2.rst | 8 +- .../migration-guides/migration-3.3.rst | 8 +- .../migration-guides/migration-3.4.rst | 16 +- .../migration-guides/migration-4.0.rst | 12 +- .../migration-guides/migration-4.1.rst | 8 +- .../migration-guides/migration-4.2.rst | 12 +- .../migration-guides/migration-5.1.rst | 12 +- .../migration-guides/migration-5.2.rst | 24 +- .../migration-guides/migration-5.3.rst | 36 +- .../migration-guides/migration-6.0.rst | 44 +- .../migration-guides/migration-6.1.rst | 12 +- .../migration-guides/release-notes-4.0.rst | 4 +- .../migration-guides/release-notes-4.3.rst | 4 +- .../migration-guides/release-notes-5.0.rst | 4 +- .../migration-guides/release-notes-5.3.rst | 8 +- documentation/overview-manual/concepts.rst | 68 +- documentation/profile-manual/intro.rst | 16 +- documentation/ref-manual/classes.rst | 168 +- .../ref-manual/devtool-reference.rst | 4 +- documentation/ref-manual/faq.rst | 20 +- documentation/ref-manual/features.rst | 12 +- documentation/ref-manual/qa-checks.rst | 20 +- documentation/ref-manual/tasks.rst | 20 +- documentation/ref-manual/variables.rst | 1635 ++++++++++++----- .../appendix-customizing-standard.rst | 4 +- .../sdk-manual/appendix-customizing.rst | 16 +- .../security-manual/read-only-rootfs.rst | 8 +- .../security-manual/securing-images.rst | 8 +- .../security-manual/sstate-signing.rst | 16 +- .../security-manual/vulnerabilities.rst | 32 +- documentation/test-manual/intro.rst | 4 +- documentation/test-manual/ptest.rst | 24 +- .../test-manual/reproducible-builds.rst | 8 +- documentation/test-manual/runtime-testing.rst | 52 +- 87 files changed, 2505 insertions(+), 843 deletions(-)