public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Quentin Schulz" <quentin.schulz@theobroma-systems.com>
To: Michael Opdenacker <michael.opdenacker@bootlin.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH v2 2/3] manuals: simplify references to BitBake manual
Date: Wed, 28 Jul 2021 10:46:50 +0200	[thread overview]
Message-ID: <20210728084650.ynbq3fofbe2c3jug@fedora> (raw)
In-Reply-To: <20210727171147.132288-3-michael.opdenacker@bootlin.com>

Hi Michael,

On Tue, Jul 27, 2021 at 07:11:46PM +0200, Michael Opdenacker wrote:
> Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
> by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
> when the reference description is the same as the section name.
> In this case, that's unnecessary to repeat the section name in the description part.
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  documentation/brief-yoctoprojectqs/index.rst     |  4 ++--
>  documentation/dev-manual/common-tasks.rst        |  2 +-
>  documentation/migration-guides/migration-2.4.rst |  4 ++--
>  documentation/overview-manual/concepts.rst       |  6 +++---
>  documentation/ref-manual/tasks.rst               |  4 ++--
>  documentation/ref-manual/variables.rst           | 12 ++++++------
>  documentation/sdk-manual/extensible.rst          |  2 +-
>  7 files changed, 17 insertions(+), 17 deletions(-)
> 
> diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
> index 8e2f2d423c..e999d925b8 100644
> --- a/documentation/brief-yoctoprojectqs/index.rst
> +++ b/documentation/brief-yoctoprojectqs/index.rst
> @@ -267,8 +267,8 @@ an entire Linux distribution, including the toolchain, from source.
>  
>     For information on using the ``bitbake`` command, see the
>     :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and
> -   Concepts Manual, or see the ":ref:`BitBake Command
> -   <bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command>`" section in the BitBake User Manual.
> +   Concepts Manual, or see the

Spurious `the` since I assume it's part of the section title just below.

> +   :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` section in the BitBake User Manual.

Otherwise,

Reviewed-by: Quentin Schulz <foss@0leil.net>

Cheers,
Quentin

  reply	other threads:[~2021-07-28  8:46 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <1695B21F5A0B37B5.3345@lists.yoctoproject.org>
2021-07-27 17:11 ` [PATCH v2 0/3] Improve/simplify references to the BitBake manual Michael Opdenacker
2021-07-27 17:11   ` [PATCH v2 1/3] documentation/README: improve BitBake manual referencing guidelines Michael Opdenacker
2021-07-27 17:11   ` [PATCH v2 2/3] manuals: simplify references to BitBake manual Michael Opdenacker
2021-07-28  8:46     ` Quentin Schulz [this message]
2021-07-28  9:13       ` [docs] " Michael Opdenacker
     [not found]       ` <1695E98A2F617A0D.29235@lists.yoctoproject.org>
2021-07-30 16:26         ` Michael Opdenacker
2021-07-27 17:11   ` [PATCH v2 3/3] manuals: remove explicit BitBake variable references Michael Opdenacker
2021-07-28  8:48   ` [docs] [PATCH v2 0/3] Improve/simplify references to the BitBake manual Quentin Schulz
2021-07-28  9:16     ` 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=20210728084650.ynbq3fofbe2c3jug@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