From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer
Date: Thu, 27 Nov 2025 17:37:47 +0100 [thread overview]
Message-ID: <20251127-bitbake-setup-updates-v1-3-75ac1e490a40@bootlin.com> (raw)
In-Reply-To: <20251127-bitbake-setup-updates-v1-0-75ac1e490a40@bootlin.com>
Console outputs are more accurately represented with the 'console'
lexer. Visually, it separates the command from the output. Switch shell
block to console blocks.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/brief-yoctoprojectqs/index.rst | 36 ++++++++++++++--------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 1e0d867d6..b8bd65f4a 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -95,13 +95,13 @@ get a copy of the ``bitbake-setup`` tool to setup the :term:`Poky` reference
distribution on your build host. Use the following commands to clone
the bitbake repository.
-.. code-block:: shell
+.. code-block:: console
$ git clone https://git.openembedded.org/bitbake
Setup a build environment with the following command:
-.. code-block:: shell
+.. code-block:: console
$ ./bitbake/bin/bitbake-setup init
@@ -110,7 +110,7 @@ By default, this will setup a top directory in the current directory.
If you prefer to setup your builds in a different top directory, for example
``$HOME/bitbake-builds``, you can set it with the :ref:`bitbake:ref-bbsetup-command-settings` command:
-.. code-block:: shell
+.. code-block:: console
$ ./bitbake/bin/bitbake-setup settings set --global default top-dir-prefix $HOME
@@ -125,7 +125,7 @@ differ from the examples below.
#. Choose a configuration (for example, ``poky-master``):
- .. code-block:: shell
+ .. code-block:: console
Available configurations:
1. poky-master Poky - The Yocto Project testing distribution configurations and hardware test platforms
@@ -140,7 +140,7 @@ differ from the examples below.
Depending on the choice above, new options can be prompted to further specify
which configuration to use. For example:
- .. code-block:: shell
+ .. code-block:: console
Available bitbake configurations:
1. poky Poky - The Yocto Project testing distribution
@@ -151,7 +151,7 @@ differ from the examples below.
#. Choose a target :term:`MACHINE` (for example, ``qemux86-64``):
- .. code-block:: shell
+ .. code-block:: console
Target machines:
1. machine/qemux86-64
@@ -165,7 +165,7 @@ differ from the examples below.
#. Choose a :term:`DISTRO` (for example, ``poky``):
- .. code-block:: shell
+ .. code-block:: console
Distribution configuration variants:
1. distro/poky
@@ -177,7 +177,7 @@ differ from the examples below.
#. Choose a :term:`bitbake:setup` directory name:
- .. code-block:: shell
+ .. code-block:: console
Enter setup directory name: [poky-master-poky-distro_poky-machine_qemux86-64]
@@ -189,7 +189,7 @@ differ from the examples below.
If you prefer to run non-interactively, you can run a command like the
following:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake-setup init --non-interactive poky-master poky-with-sstate distro/poky machine/qemux86-64
@@ -248,7 +248,7 @@ an entire Linux distribution, including the toolchain, from source.
environment setup script within the :term:`bitbake:BitBake build` directory
to setup the :term:`BitBake` build environment on your host:
- .. code-block:: shell
+ .. code-block:: console
$ source poky-master-poky-distro_poky-machine_qemux86-64/build/init-build-env
Poky reference distro build
@@ -261,7 +261,7 @@ an entire Linux distribution, including the toolchain, from source.
With this tool, list the currently enabled :term:`configuration fragments
<Configuration Fragment>`:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake-config-build list-fragments
@@ -288,7 +288,7 @@ an entire Linux distribution, including the toolchain, from source.
can be useful for development, you can enable the
:ref:`ref-fragments-root-login-with-empty-password` fragment:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake-config-build enable-fragment root-login-with-empty-password
@@ -318,7 +318,7 @@ an entire Linux distribution, including the toolchain, from source.
#. **Start the Build:** Continue with the following command to build an OS
image for the target, which is ``core-image-sato`` in this example:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake core-image-sato
@@ -332,7 +332,7 @@ an entire Linux distribution, including the toolchain, from source.
built, you can start QEMU, which is a Quick EMUlator that ships with
the Yocto Project:
- .. code-block:: shell
+ .. code-block:: console
$ runqemu qemux86-64
@@ -378,7 +378,7 @@ layer>`:
For this, the ``bitbake-layers add-layer`` can be used:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake-layers add-layer ../layers/meta-raspberrypi
@@ -393,7 +393,7 @@ layer>`:
machine, so let's make it the :term:`MACHINE` used for the build with
``bitbake-config-build``:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake-config-build enable-fragment machine/raspberrypi5
@@ -414,7 +414,7 @@ layer>`:
#. **Start The Build:** The configuration is now set to build for the Raspberry
Pi 5. Start the build again:
- .. code-block:: shell
+ .. code-block:: console
$ bitbake core-image-sato
@@ -441,7 +441,7 @@ configuration file, a ``recipes-example`` subdirectory that contains an
The following commands run the tool to create a layer named
``meta-mylayer``:
-.. code-block:: shell
+.. code-block:: console
$ bitbake-layers create-layer ../layers/meta-mylayer
NOTE: Starting bitbake server...
--
2.51.0
next prev parent reply other threads:[~2025-11-27 16:38 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-27 16:37 [PATCH 0/3] bitbake-setup updates Antonin Godard
2025-11-27 16:37 ` [PATCH 1/3] poky.yaml.in: add DISTRO_RELEASE_SERIES Antonin Godard
2025-11-27 16:37 ` [PATCH 2/3] brief-yoctoprojectqs/index.rst: update available bitbake-setup configurations Antonin Godard
2025-11-27 16:37 ` Antonin Godard [this message]
2025-11-27 16:47 ` [docs] [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer Quentin Schulz
2025-11-28 13:11 ` Antonin Godard
2025-11-28 13:14 ` Antonin Godard
2025-11-28 13:30 ` Quentin Schulz
2025-11-28 13:46 ` Antonin Godard
2025-12-01 8:35 ` [PATCH 0/3] bitbake-setup updates Antonin Godard
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=20251127-bitbake-setup-updates-v1-3-75ac1e490a40@bootlin.com \
--to=antonin.godard@bootlin.com \
--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