mbox series

[v2,00/12] sdk-manual: fix code-blocks, migrate one PNG to SVG, remove unused PNG

Message ID 20260121-code-block-misc-20260114-v2-0-fdd4bb5c2e68@cherry.de
Headers show
Series sdk-manual: fix code-blocks, migrate one PNG to SVG, remove unused PNG | expand

Message

Quentin Schulz Jan. 21, 2026, 1:31 p.m. UTC
This migrates literal and code blocks to an explicit lexer in
sdk-manual.

It also migrate one PNG to SVG (one that was "easy enough" for me to
quickly do), as well as deleting an unused PNG.

In addition, this removes two PNGs in favor of simple parsed literal
blocks when listing the directory layout as it doesn't bring anything
valuable and makes accessibility worse.

Finally, it also fixes some improper indent that resulted in
explanations unintentionally being part of a code-block.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Changes in v2:
- used parsed-literal blocks instead of code-blocks for directory
  layout,
- highlighted placeholders with the same mechanism as in parsed-literal
  blocks (italicized),
- highlighted possible values of placeholders with double-tick instead
  of single-tick,
- updated directory layout with output from 5.0.15 toolchains,
- reorder alphabetically the directory layouts such that files and
  directories are now mixed,
- reworded text after the now-deleted figures as it still said "Within
  the figure", and highlighted placeholders in the text the same way
  as they appear in the parsed-literal block,
- added patch to use parsed-literal block for the naming convention of
  the install scripts,
- added patch to fix SDK filename example,
- added patch to fix default path for eSDK installer script,
- Link to v1: https://patch.msgid.link/20260114-code-block-misc-20260114-v1-0-174a6e5dba69@cherry.de

---
Quentin Schulz (12):
      sdk-manual: fix incorrect highlight language for text code-blocks
      sdk-manual: fix incorrect highlight language for console code-blocks
      sdk-manual: fix improper indent of general form of tarball installer scripts
      sdk-manual: working-projects: properly highlight code code-blocks
      sdk-manual: appending-customizing: use none lexer for BitBake code blocks
      sdk-manual: appendix-obtain: replace directory structure PNG with a parsed-literal block
      sdk-manual: appendix-obtain: replace eSDK directory structure PNG with a parsed-literal block
      sdk-manual: replace sdk-environment PNG with SVG
      sdk-manual: delete sdk-title PNG
      sdk-manual: appendix-obtain: use parsed-literal block for naming convention of the installer scripts
      sdk-manual: using: fix SDK filename example
      sdk-manual: appendix-obtain: fix default path for eSDK installer script

 documentation/sdk-manual/appendix-customizing.rst  |  36 +-
 documentation/sdk-manual/appendix-obtain.rst       | 154 +++++--
 documentation/sdk-manual/extensible.rst            |  63 +--
 .../sdk-manual/figures/sdk-environment.png         | Bin 42098 -> 0 bytes
 .../sdk-installed-extensible-sdk-directory.png     | Bin 66753 -> 0 bytes
 .../sdk-installed-standard-sdk-directory.png       | Bin 39099 -> 0 bytes
 documentation/sdk-manual/figures/sdk-title.png     | Bin 31039 -> 0 bytes
 documentation/sdk-manual/intro.rst                 |   2 +-
 documentation/sdk-manual/svg/sdk-environment.svg   | 463 +++++++++++++++++++++
 documentation/sdk-manual/using.rst                 |  35 +-
 documentation/sdk-manual/working-projects.rst      | 112 +++--
 11 files changed, 746 insertions(+), 119 deletions(-)
---
base-commit: b8a56b8b2e8c0417b2f7204f80c79b05d95e9ce4
change-id: 20260114-code-block-misc-20260114-bf035e4362c2

Best regards,