diff mbox series

[09/10] sdk-manual: use the bitbake code-block language

Message ID 20260826013502.2674000-10-twoerner@gmail.com
State New
Headers show
Series docs: highlight BitBake snippets with the bitbake language | expand

Commit Message

Trevor Woerner Aug. 26, 2026, 1:34 a.m. UTC 
BitBake snippets here render as unhighlighted text. A reStructuredText
literal block carries no language, and Sphinx falls back to a default
that cannot recognise BitBake metadata.

Pygments 2.21 added a BitBake lexer, so tag these 9 blocks
explicitly. Variable names, assignment operators, override chains,
expansions and shell or Python task bodies are then highlighted.

Blocks that only look like BitBake are left alone, as are blocks
already tagged "none" where the content is deliberately unhighlighted.

AI-Generated: codex/claude-opus 5 (xhigh)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 .../sdk-manual/appendix-customizing-standard.rst |  4 +++-
 .../sdk-manual/appendix-customizing.rst          | 16 ++++++++--------
 2 files changed, 11 insertions(+), 9 deletions(-)
diff mbox series

Patch

diff --git a/documentation/sdk-manual/appendix-customizing-standard.rst b/documentation/sdk-manual/appendix-customizing-standard.rst
index 90b73dc20d7a..e0437270d1dd 100644
--- a/documentation/sdk-manual/appendix-customizing-standard.rst
+++ b/documentation/sdk-manual/appendix-customizing-standard.rst
@@ -27,7 +27,9 @@  Adding API Documentation to the Standard SDK
 
 You can include API documentation as well as any other documentation
 provided by recipes with the standard SDK by adding "api-documentation"
-to the :term:`DISTRO_FEATURES` variable::
+to the :term:`DISTRO_FEATURES` variable:
+
+.. code-block:: bitbake
 
    DISTRO_FEATURES:append = " api-documentation"
 
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst
index 467c5c10c32c..497db2fb9f50 100644
--- a/documentation/sdk-manual/appendix-customizing.rst
+++ b/documentation/sdk-manual/appendix-customizing.rst
@@ -149,7 +149,7 @@  The
 class defines the default value of the :term:`SDK_TITLE` variable as
 follows:
 
-.. code-block:: none
+.. code-block:: bitbake
 
    SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK"
 
@@ -163,7 +163,7 @@  does the default "poky" distribution. If so, you could update the
 ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following
 form:
 
-.. code-block:: none
+.. code-block:: bitbake
 
    SDK_TITLE = "your_title"
 
@@ -220,7 +220,7 @@  within the
 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
 class as follows:
 
-.. code-block:: none
+.. code-block:: bitbake
 
    SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
 
@@ -239,7 +239,7 @@  does the default "poky" distribution. If so, you could update the
 ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following
 form:
 
-.. code-block:: none
+.. code-block:: bitbake
 
    SDKEXTPATH = "some_path_for_your_installed_sdk"
 
@@ -275,7 +275,7 @@  source, you need to do a number of things:
    to find the configuration. The variable you need to set is
    :term:`SSTATE_MIRRORS`:
 
-   .. code-block:: none
+   .. code-block:: bitbake
 
       SSTATE_MIRRORS = "file://.* https://example.com/some_path/sstate-cache/PATH"
 
@@ -290,7 +290,7 @@  source, you need to do a number of things:
       configuration file. You can then pass the variable to the SDK by
       adding the following:
 
-      .. code-block:: none
+      .. code-block:: bitbake
 
          ESDK_LOCALCONF_ALLOW = "SSTATE_MIRRORS"
 
@@ -315,7 +315,7 @@  more in size. If the size of this file causes a problem, you can build
 an SDK that has just enough in it to install and provide access to the
 ``devtool command`` by setting the following in your configuration:
 
-.. code-block:: none
+.. code-block:: bitbake
 
    SDK_EXT_TYPE = "minimal"
 
@@ -339,7 +339,7 @@  results.
 To facilitate this wider range of information, you would need to set the
 following:
 
-.. code-block:: none
+.. code-block:: bitbake
 
    SDK_INCLUDE_PKGDATA = "1"