ref-manual: add links to some variables in glossary

Submitted by Robert P. J. Day on May 21, 2021, 9:57 a.m. | Patch ID: 179746

Details

Message ID 1bccf6a-c79-cb46-a04-2fb4a2ed8c6b@crashcourse.ca
State New
Headers show

Commit Message

Robert P. J. Day May 21, 2021, 9:57 a.m.
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

Patch hide | download patch | download mbox

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

Comments

Michael Opdenacker May 21, 2021, 11:59 a.m.
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.
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#1295): https://lists.yoctoproject.org/g/docs/message/1295
Mute This Topic: https://lists.yoctoproject.org/mt/82982352/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Robert P. J. Day May 21, 2021, 3:18 p.m.
On Fri, 21 May 2021, Michael Opdenacker wrote:

> Hi Robert,

...snip ...

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

  i typically won't add a reference if there is already one in the
vicinity.

rday
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#1296): https://lists.yoctoproject.org/g/docs/message/1296
Mute This Topic: https://lists.yoctoproject.org/mt/82982352/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-