All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] ref-manual: add links to some variables in glossary
@ 2021-05-21  9:57 Robert P. J. Day
  2021-05-21 11:59 ` [docs] " Michael Opdenacker
  0 siblings, 1 reply; 3+ messages in thread
From: Robert P. J. Day @ 2021-05-21  9:57 UTC (permalink / raw)
  To: YP docs mailing list


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

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                         http://crashcourse.ca

LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [docs] [PATCH] ref-manual: add links to some variables in glossary
  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
  2021-05-21 15:18   ` Robert P. J. Day
  0 siblings, 1 reply; 3+ messages in thread
From: Michael Opdenacker @ 2021-05-21 11:59 UTC (permalink / raw)
  To: Robert P. J. Day, YP docs mailing list

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.


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [docs] [PATCH] ref-manual: add links to some variables in glossary
  2021-05-21 11:59 ` [docs] " Michael Opdenacker
@ 2021-05-21 15:18   ` Robert P. J. Day
  0 siblings, 0 replies; 3+ messages in thread
From: Robert P. J. Day @ 2021-05-21 15:18 UTC (permalink / raw)
  To: Michael Opdenacker; +Cc: YP docs mailing list

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-05-21 15:18 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-21  9:57 [PATCH] ref-manual: add links to some variables in glossary Robert P. J. Day
2021-05-21 11:59 ` [docs] " Michael Opdenacker
2021-05-21 15:18   ` Robert P. J. Day

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.