public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Antonin Godard <antonin.godard@bootlin.com>
To: bitbake-devel@lists.openembedded.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	 docs@lists.yoctoproject.org,
	Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH 2/2] doc/bitbake-user-manual-environment-setup.rst: replace shell blocks by console
Date: Tue, 31 Mar 2026 10:14:52 +0200	[thread overview]
Message-ID: <20260331-docs-fixes-v1-2-45ee34341e72@bootlin.com> (raw)
In-Reply-To: <20260331-docs-fixes-v1-0-45ee34341e72@bootlin.com>

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

-- 
2.53.0



      parent reply	other threads:[~2026-03-31  8:15 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-31  8:14 [PATCH 0/2] bitbake-setup docs fixes Antonin Godard
2026-03-31  8:14 ` [PATCH 1/2] bitbake-setup: rename "abort" rebase conflict stragegy to "halt" Antonin Godard
2026-03-31  9:00   ` [docs] " Quentin Schulz
2026-03-31 10:43     ` Richard Purdie
2026-03-31 11:36       ` [bitbake-devel] " Alexander Kanavin
2026-04-03  8:07         ` Antonin Godard
2026-04-03 10:04           ` Alexander Kanavin
2026-04-03 10:16             ` Richard Purdie
2026-04-04  7:34               ` Adam Blank
2026-04-04 15:33                 ` Alexander Kanavin
2026-04-04 15:58                   ` Adam Blank
2026-04-04 16:16                     ` Alexander Kanavin
2026-04-04 16:25                       ` Adam Blank
     [not found]                     ` <18A333954F38AD11.657799@lists.yoctoproject.org>
2026-04-04 16:29                       ` Alexander Kanavin
2026-04-04 17:06                         ` Adam Blank
2026-04-04 17:13                           ` Alexander Kanavin
2026-03-31  8:14 ` Antonin Godard [this message]

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=20260331-docs-fixes-v1-2-45ee34341e72@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=bitbake-devel@lists.openembedded.org \
    --cc=docs@lists.yoctoproject.org \
    --cc=thomas.petazzoni@bootlin.com \
    /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