[PATCH] doc: use monospaced font for visual clarity of options

[PATCH] doc: use monospaced font for visual clarity of options

[Robert P. J. Day]

Use monospaced font for command options, to make it clear when double
dashes are being used.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  since i saw an example of this being done in the same chapter
of the bitbake manual without quotes, i chose to do it that way.

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
index 329b02829..4e70eaf9d 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
@@ -538,7 +538,7 @@ The following command runs the clean task on the ``foo.bb`` recipe file::

 .. note::

-   The "-b" option explicitly does not handle recipe dependencies. Other
+   The ``-b`` option explicitly does not handle recipe dependencies. Other
    than for debugging purposes, it is instead recommended that you use
    the syntax presented in the next section.

@@ -553,7 +553,7 @@ dependencies, both for build-time and runtime. There must be a way for
 you to express recipe preferences when multiple recipes provide the same
 functionality, or when there are multiple versions of a recipe.

-The ``bitbake`` command, when not using "--buildfile" or "-b" only
+The ``bitbake`` command, when not using ``--buildfile`` or ``-b`` only
 accepts a "PROVIDES". You cannot provide anything else. By default, a
 recipe file generally "PROVIDES" its "packagename" as shown in the
 following example::
@@ -561,7 +561,7 @@ following example::
   $ bitbake foo

 This next example "PROVIDES" the
-package name and also uses the "-c" option to tell BitBake to just
+package name and also uses the ``-c`` option to tell BitBake to just
 execute the ``do_clean`` task::

   $ bitbake -c clean foo

Re: [bitbake-devel] [PATCH] doc: use monospaced font for visual clarity of options

[Antonin Godard]

On Thu Jan 8, 2026 at 5:25 PM CET, Robert P. J. Day wrote:
>
> Use monospaced font for command options, to make it clear when double
> dashes are being used.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
>   since i saw an example of this being done in the same chapter
> of the bitbake manual without quotes, i chose to do it that way.
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> index 329b02829..4e70eaf9d 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> @@ -538,7 +538,7 @@ The following command runs the clean task on the ``foo.bb`` recipe file::
>
>  .. note::
>
> -   The "-b" option explicitly does not handle recipe dependencies. Other
> +   The ``-b`` option explicitly does not handle recipe dependencies. Other
>     than for debugging purposes, it is instead recommended that you use
>     the syntax presented in the next section.
>
> @@ -553,7 +553,7 @@ dependencies, both for build-time and runtime. There must be a way for
>  you to express recipe preferences when multiple recipes provide the same
>  functionality, or when there are multiple versions of a recipe.
>
> -The ``bitbake`` command, when not using "--buildfile" or "-b" only
> +The ``bitbake`` command, when not using ``--buildfile`` or ``-b`` only
>  accepts a "PROVIDES". You cannot provide anything else. By default, a
>  recipe file generally "PROVIDES" its "packagename" as shown in the
>  following example::
> @@ -561,7 +561,7 @@ following example::
>    $ bitbake foo
>
>  This next example "PROVIDES" the
> -package name and also uses the "-c" option to tell BitBake to just
> +package name and also uses the ``-c`` option to tell BitBake to just
>  execute the ``do_clean`` task::
>
>    $ bitbake -c clean foo

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com