Yocto Project Documentation
 help / color / mirror / Atom feed
From: Quentin Schulz <quentin.schulz@cherry.de>
To: antonin.godard@bootlin.com, docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [docs] [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer
Date: Thu, 27 Nov 2025 17:47:23 +0100	[thread overview]
Message-ID: <1d128f7c-1af4-4e11-9ce9-b72cecff0485@cherry.de> (raw)
In-Reply-To: <20251127-bitbake-setup-updates-v1-3-75ac1e490a40@bootlin.com>

Hi Antonin,

On 11/27/25 5:37 PM, Antonin Godard via lists.yoctoproject.org wrote:
> 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
>   

Neither shell nor console. I would suggest to simply use a literal block 
(::), c.f. 
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#rst-literal-blocks

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

Ditto.

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

Ditto.

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

Ditto.

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

Ditto.

Cheers,
Quentin


  reply	other threads:[~2025-11-27 16:47 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 ` [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer Antonin Godard
2025-11-27 16:47   ` Quentin Schulz [this message]
2025-11-28 13:11     ` [docs] " 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=1d128f7c-1af4-4e11-9ce9-b72cecff0485@cherry.de \
    --to=quentin.schulz@cherry.de \
    --cc=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