From: "Quentin Schulz" <quentin.schulz@theobroma-systems.com>
To: Michael Opdenacker <michael.opdenacker@bootlin.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH] manuals: font fixes
Date: Mon, 6 Sep 2021 15:33:50 +0200 [thread overview]
Message-ID: <20210906133350.fcijjn7u4yhisibq@fedora> (raw)
In-Reply-To: <20210903085125.2033899-1-michael.opdenacker@bootlin.com>
Hi Michael,
On Fri, Sep 03, 2021 at 10:51:25AM +0200, Michael Opdenacker wrote:
> This fixes font inconsistencies, mixing a ``text`` string
> with another string with the regular font, where the whole string
> makes more sense with a single font.
>
> The result is also much simpler and will make future
> searches easiers.
>
But you also lose the indication that this given string should be
replaced by the user.
Cheers,
Quentin
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
> documentation/dev-manual/common-tasks.rst | 4 ++--
> documentation/migration-guides/migration-2.7.rst | 4 ++--
> documentation/overview-manual/concepts.rst | 2 +-
> documentation/ref-manual/classes.rst | 4 ++--
> documentation/ref-manual/faq.rst | 2 +-
> documentation/ref-manual/terms.rst | 2 +-
> documentation/ref-manual/variables.rst | 6 +++---
> 7 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index ec43ea4a70..d57ee1a25e 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -9383,8 +9383,8 @@ log to ``${T}/log.do_``\ `task`, and can also log to standard output
>
> Calling this function does not cause the task to fail.
>
> -- ``bb.fatal(``\ msg\ ``)``: This logging function is similar to
> - ``bb.error(``\ msg\ ``)`` but also causes the calling task to fail.
> +- ``bb.fatal(msg)``: This logging function is similar to
> + ``bb.error(msg)`` but also causes the calling task to fail.
>
> .. note::
>
> diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst
> index 69bd390603..ae70353bf7 100644
> --- a/documentation/migration-guides/migration-2.7.rst
> +++ b/documentation/migration-guides/migration-2.7.rst
> @@ -87,8 +87,8 @@ This section provides information about packaging changes.
> ``bind-utils`` package.
>
> - Debug split: The default debug split has been changed to create
> - separate source packages (i.e. package_name\ ``-dbg`` and
> - package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in
> + separate source packages (i.e. ``package_name-dbg`` and
> + ``package_name-src``). If you are currently using ``dbg-pkgs`` in
> :term:`IMAGE_FEATURES` to bring in debug
> symbols and you still need the sources, you must now also add
> ``src-pkgs`` to :term:`IMAGE_FEATURES`. Source packages remain in the
> diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
> index c8b89885e3..1137010eff 100644
> --- a/documentation/overview-manual/concepts.rst
> +++ b/documentation/overview-manual/concepts.rst
> @@ -1200,7 +1200,7 @@ usually made available in the form of a shared state (sstate) cache.
> :term:`SSTATE_MIRRORS`
> variables.
>
> -The idea of a setscene task (i.e ``do_``\ taskname\ ``_setscene``) is a
> +The idea of a setscene task (i.e ``do_taskname_setscene``) is a
> version of the task where instead of building something, BitBake can
> skip to the end result and simply place a set of files into specific
> locations as needed. In some cases, it makes sense to have a setscene
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 3af023895e..aa8fd637f4 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1600,7 +1600,7 @@ or other tools from the build host).
> You can create a recipe that builds tools that run natively on the host
> a couple different ways:
>
> -- Create a myrecipe\ ``-native.bb`` recipe that inherits the ``native``
> +- Create a ``myrecipe-native.bb`` recipe that inherits the ``native``
> class. If you use this method, you must order the inherit statement
> in the recipe after all other inherit statements so that the
> ``native`` class is inherited last.
> @@ -1642,7 +1642,7 @@ wish to build tools to run as part of an SDK (i.e. tools that run on
> You can create a recipe that builds tools that run on the SDK machine a
> couple different ways:
>
> -- Create a ``nativesdk-``\ myrecipe\ ``.bb`` recipe that inherits the
> +- Create a ``nativesdk-myrecipe.bb`` recipe that inherits the
> ``nativesdk`` class. If you use this method, you must order the
> inherit statement in the recipe after all other inherit statements so
> that the ``nativesdk`` class is inherited last.
> diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
> index d3a603d4a4..f40367bd58 100644
> --- a/documentation/ref-manual/faq.rst
> +++ b/documentation/ref-manual/faq.rst
> @@ -143,7 +143,7 @@ various proxy types and configuring proxy servers, see the
> ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
> Wiki page.
>
> -**Q:** What's the difference between target and target\ ``-native``?
> +**Q:** What's the difference between ``target`` and ``target-native``?
>
> **A:** The ``*-native`` targets are designed to run on the system being
> used for the build. These are usually tools that are needed to assist
> diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
> index 32658051a5..6663b8603e 100644
> --- a/documentation/ref-manual/terms.rst
> +++ b/documentation/ref-manual/terms.rst
> @@ -31,7 +31,7 @@ universal, the list includes them just in case:
> busybox_1.21.%.bbappend
>
> That append file
> - would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So,
> + would match any ``busybox_1.21.x.bb`` version of the recipe. So,
> the append file would match any of the following recipe names:
>
> .. code-block:: shell
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 3a090354e0..9c6d2a51e8 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -730,7 +730,7 @@ system and gives an overview of their function and contents.
> Each configuration file you
> use must reside in the :term:`Build Directory`
> ``conf/multiconfig`` directory (e.g.
> - build_directory\ ``/conf/multiconfig/configA.conf``).
> + ``build_directory/conf/multiconfig/configA.conf``).
>
> For information on how to use :term:`BBMULTICONFIG` in an environment
> that supports building targets with multiple configurations, see the
> @@ -5347,7 +5347,7 @@ system and gives an overview of their function and contents.
> so one of two ways:
>
> - *Append file:* Create an append file named
> - recipename\ ``.bbappend`` in your layer and override the value of
> + ``recipename.bbappend`` in your layer and override the value of
> :term:`PACKAGECONFIG`. You can either completely override the
> variable::
>
> @@ -8690,7 +8690,7 @@ system and gives an overview of their function and contents.
> :term:`WKS_FILE`
> Specifies the location of the Wic kickstart file that is used by the
> OpenEmbedded build system to create a partitioned image
> - (image\ ``.wic``). For information on how to create a partitioned
> + (``image.wic``). For information on how to create a partitioned
> image, see the
> ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
> section in the Yocto Project Development Tasks Manual. For details on
> --
> 2.25.1
>
>
>
>
next prev parent reply other threads:[~2021-09-06 13:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-03 8:51 [PATCH] manuals: font fixes Michael Opdenacker
2021-09-06 13:33 ` Quentin Schulz [this message]
2021-09-13 14:26 ` [docs] " Michael Opdenacker
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=20210906133350.fcijjn7u4yhisibq@fedora \
--to=quentin.schulz@theobroma-systems.com \
--cc=docs@lists.yoctoproject.org \
--cc=michael.opdenacker@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;
as well as URLs for NNTP newsgroup(s).