diff mbox series

[2/2] doc/bitbake-user-manual-environment-setup.rst: replace shell blocks by console

Message ID 20260331-docs-fixes-v1-2-45ee34341e72@bootlin.com
State New
Headers show
Series bitbake-setup docs fixes | expand

Commit Message

Antonin Godard March 31, 2026, 8:14 a.m. UTC 
The appropriate lexer to use for command examples is console, not shell.
Replace all misuses of this lexer in this document.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 .../bitbake-user-manual-environment-setup.rst      | 30 +++++++++++-----------
 1 file changed, 15 insertions(+), 15 deletions(-)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
index c7b73001404..ece872ad26c 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -27,7 +27,7 @@  Quick Start
 
 #. If you haven't already, clone the BitBake repository:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ git clone https://git.openembedded.org/bitbake
 
@@ -36,7 +36,7 @@  Quick Start
 
    To start, run:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ ./bitbake/bin/bitbake-setup init
 
@@ -94,7 +94,7 @@  Quick Start
 #. Source the ``init-build-env`` file present in the :term:`BitBake Build`
    directory:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ source ./poky-master-poky-distro_poky-machine_qemux86-64/build/init-build-env
 
@@ -343,7 +343,7 @@  In addition, the command can take the following arguments:
 -  This example prompts the user to choose a :term:`Configuration Template` from
    a custom registry:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ ./bitbake/bin/bitbake-setup \
           --setting default registry 'git://example.com/bitbake-setup-configurations.git;protocol=https;branch=main;rev=main' \
@@ -352,7 +352,7 @@  In addition, the command can take the following arguments:
 -  This example takes a :term:`Configuration Template` from a remote location
    (here, one of the default configuration in BitBake):
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ ./bitbake/bin/bitbake-setup init https://git.openembedded.org/bitbake/plain/default-registry/configurations/oe-nodistro-master.conf.json
 
@@ -363,7 +363,7 @@  In addition, the command can take the following arguments:
    -  A standalone :term:`Configuration Template` file.
    -  Choices passed on the command-line, applied non-interactively.
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ ./bitbake/bin/bitbake-setup \
           --setting default top-dir-prefix /work/bitbake-setup \
@@ -477,7 +477,7 @@  In addition, the command can take the following arguments:
    environment. Local commits in any layer directory are rebased on top of
    the new upstream revision and preserved:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ bitbake-setup update
       NOTE: Bitbake-setup is using /path/to/bitbake-builds as top directory.
@@ -493,7 +493,7 @@  In addition, the command can take the following arguments:
 -  This example shows what happens when a layer directory contains staged or
    unstaged changes to tracked files. The update is blocked with an error:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ bitbake-setup update
       NOTE: Bitbake-setup is using /path/to/bitbake-builds as top directory.
@@ -515,7 +515,7 @@  In addition, the command can take the following arguments:
 
    Stashing the changes and re-running resolves the issue:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ git -C layers/openembedded-core stash
       $ bitbake-setup update
@@ -526,7 +526,7 @@  In addition, the command can take the following arguments:
    is automatically halted, and the ``dldir`` remote is left in the repository
    for manual resolution:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ bitbake-setup update
       ERROR: Repository at layers/openembedded-core has local commits that could
@@ -539,7 +539,7 @@  In addition, the command can take the following arguments:
    The conflict can be resolved manually using the ``dldir`` remote that
    ``bitbake-setup`` adds to the repository:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ git -C layers/openembedded-core rebase dldir/master
       # fix conflicts in an editor, then stage the resolved files:
@@ -552,7 +552,7 @@  In addition, the command can take the following arguments:
    preserves the conflicting directory under a timestamped backup path and
    re-clones the layer cleanly from upstream:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ bitbake-setup update --rebase-conflicts-strategy=backup
       NOTE: Bitbake-setup is using /path/to/bitbake-builds as top directory.
@@ -583,7 +583,7 @@  In addition, the command can take the following arguments:
    the following commands can be used to apply these commits on top of the new
    upstream revision in the fresh clone:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ git -C layers/openembedded-core-backup.20260329160426 log --oneline my-wip
       a1b2c3d u-boot: fix compilation with newer GCC
@@ -620,7 +620,7 @@  In addition, the command can take the following arguments:
    Once all desired commits have been recovered and verified, the backup
    directory can be removed:
 
-   .. code-block:: shell
+   .. code-block:: console
 
       $ rm -rf layers/openembedded-core-backup.20260329160426
 
@@ -856,7 +856,7 @@  These files are written in the JSON file format and are stored in a
 :term:`Registry`. They can also be standalone files directly passed to the
 :ref:`ref-bbsetup-command-init` command:
 
-.. code-block:: shell
+.. code-block:: console
 
    $ bitbake-setup init /path/to/config.conf.json