From: "Michael Opdenacker" <michael.opdenacker@bootlin.com>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>,
YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH] ref-manual: add links to some variables in glossary
Date: Fri, 21 May 2021 13:59:05 +0200 [thread overview]
Message-ID: <904a39a0-1f55-536c-2b4c-fad8763995f9@bootlin.com> (raw)
In-Reply-To: <1bccf6a-c79-cb46-a04-2fb4a2ed8c6b@crashcourse.ca>
Hi Robert,
On 5/21/21 11:57 AM, Robert P. J. Day wrote:
> Add some links to a small set of glossary variables that I happened
> to be perusing at the time.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> commit ab92c97908bf80b1148f67121c692183b3c47ffc
> Author: Robert P. J. Day <rpjday@crashcourse.ca>
> Date: Fri May 21 05:55:32 2021 -0400
>
> add links to some vars in glossary
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 0b61f77cb..5c15bb351 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1525,10 +1525,10 @@ system and gives an overview of their function and contents.
>
> :term:`DEBUG_BUILD`
> Specifies to build packages with debugging information. This
> - influences the value of the ``SELECTED_OPTIMIZATION`` variable.
> + influences the value of the :term:`SELECTED_OPTIMIZATION` variable.
>
> :term:`DEBUG_OPTIMIZATION`
> - The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when
> + The options to pass in :term:`TARGET_CFLAGS` and :term:`CFLAGS` when
> compiling a system for debugging. This variable defaults to "-O
> -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
>
> @@ -1538,7 +1538,7 @@ system and gives an overview of their function and contents.
> The most common usage of this is variable is to set it to "-1" within
> a recipe for a development version of a piece of software. Using the
> variable in this way causes the stable version of the recipe to build
> - by default in the absence of ``PREFERRED_VERSION`` being used to
> + by default in the absence of :term:`PREFERRED_VERSION` being used to
> build the development version.
>
> .. note::
> @@ -2579,7 +2579,7 @@ system and gives an overview of their function and contents.
> Set the variable to "1" to force the removal of these packages.
>
> :term:`FULL_OPTIMIZATION`
> - The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when
> + The options to pass in :term:`TARGET_CFLAGS` and :term:`CFLAGS` when
> compiling an optimized system. This variable defaults to "-O2 -pipe
> ${DEBUG_FLAGS}".
>
> @@ -6691,8 +6691,8 @@ system and gives an overview of their function and contents.
> value of the :term:`TARGET_CFLAGS` variable.
>
> The ``SELECTED_OPTIMIZATION`` variable takes the value of
> - ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the
> - case, the value of ``DEBUG_OPTIMIZATION`` is used.
> + :term:`FULL_OPTIMIZATION` unless :term:`DEBUG_BUILD` = "1", in which
> + case the value of :term:`DEBUG_OPTIMIZATION` is used.
>
> :term:`SERIAL_CONSOLE`
> Defines a serial console (TTY) to enable using
Thanks for the patch. I checked that the corresponding variables didn't
already have a nearby reference to the glossary, but that wasn't the case.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Applied to master-next.
Cheers,
Michael.
next prev parent reply other threads:[~2021-05-21 11:59 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-21 9:57 [PATCH] ref-manual: add links to some variables in glossary Robert P. J. Day
2021-05-21 11:59 ` Michael Opdenacker [this message]
2021-05-21 15:18 ` [docs] " Robert P. J. Day
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=904a39a0-1f55-536c-2b4c-fad8763995f9@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=rpjday@crashcourse.ca \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.