Yocto Project Documentation
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH 09/10] sdk-manual: use the bitbake code-block language
Date: Tue, 25 Aug 2026 21:34:54 -0400	[thread overview]
Message-ID: <20260826013502.2674000-10-twoerner@gmail.com> (raw)
In-Reply-To: <20260826013502.2674000-1-twoerner@gmail.com>

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 --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"
 


  parent reply	other threads:[~2026-08-26  1:35 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-26  1:34 [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language Trevor Woerner
2026-08-26  1:34 ` [PATCH 01/10] ref-manual/variables.rst: use the bitbake code-block language Trevor Woerner
2026-08-26  1:34 ` [PATCH 02/10] ref-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 03/10] dev-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 04/10] migration-guides: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 05/10] kernel-dev: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 06/10] test-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 07/10] overview-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 08/10] security-manual: " Trevor Woerner
2026-08-26  1:34 ` Trevor Woerner [this message]
2026-08-26  1:34 ` [PATCH 10/10] docs-wide: " Trevor Woerner
2026-08-26 11:56 ` [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language Paul Barker
2026-08-26 13:29   ` Trevor Woerner
2026-08-26 12:10 ` [docs] " Quentin Schulz
2026-08-26 13:09   ` Antonin Godard
2026-08-26 13:25     ` Trevor Woerner
2026-08-26 14:45       ` Quentin Schulz
2026-08-26 19:56         ` Trevor Woerner
2026-08-27 14:33           ` Quentin Schulz
2026-08-31  9:01             ` Antonin Godard
2026-08-31 13:18               ` Trevor Woerner
2026-08-31 14:16               ` Trevor Woerner
2026-08-31 15:19                 ` Antonin Godard
2026-08-31 15:55                   ` Trevor Woerner
2026-09-01  7:31                     ` Antonin Godard
2026-08-26 14:34     ` Quentin Schulz
2026-08-26 15:10       ` Antonin Godard
2026-08-26 15:43         ` Quentin Schulz
2026-08-27  8:02           ` Antonin Godard
2026-08-27  8:38 ` Antonin Godard
2026-08-27 11:34   ` Trevor Woerner
2026-08-27 12:16     ` Antonin Godard
2026-08-27 14:23       ` Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260826013502.2674000-10-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox