diff mbox series

[10/17] ref-manual/variables.rst: document the USE_NLS variable

Message ID 20251016-release-note-5-3-second-hunk-v1-10-20f21db1f93c@bootlin.com
State New
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 16, 2025, 8:54 a.m. UTC
Part of bitbake.conf, this variable allowing to enable or disable
translation was undocumented. Add a entry to the glossary.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Quentin Schulz Oct. 16, 2025, 10:25 a.m. UTC | #1
Hi Antonin,

On 10/16/25 10:54 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Part of bitbake.conf, this variable allowing to enable or disable
> translation was undocumented. Add a entry to the glossary.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index bb24f2583..f16ef9aae 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -11117,6 +11117,19 @@ system and gives an overview of their function and contents.
>         the Yocto Project Development Tasks Manual for information on how to
>         use this variable.
>   
> +   :term:`USE_NLS`
> +      Determines if translations should be built for recipes that can build
> +      language translations. This variable can be equal to:

Suggesting:

Determine if language translations should be built for recipes that can 
build them.

> +
> +      -  ``yes``: translations are enabled.
> +      -  ``no``: translation are disabled.
> +
> +      The :ref:`ref-classes-gettext` class uses this variable to enable
> +      :wikipedia:`Gettext <Gettext>` in recipes that use this class. Recipes can

Suggesting:

It is used to enable :wikipedia:`Gettext <Gettext>` in recipes 
inheriting the :ref:`ref-classes-gettext`.

> +      also use the :term:`USE_NLS` variable directly to override the default
> +      value of the variable, and configure themselves according to the value of
> +      the variable.

I mean.... the same can be said about any variable? But the "magic" 
documented stuff that happens when setting USE_NLS only happens if you 
inherit the class, so I would simply not document using this variable 
"manually"?

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index bb24f2583..f16ef9aae 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -11117,6 +11117,19 @@  system and gives an overview of their function and contents.
       the Yocto Project Development Tasks Manual for information on how to
       use this variable.
 
+   :term:`USE_NLS`
+      Determines if translations should be built for recipes that can build
+      language translations. This variable can be equal to:
+
+      -  ``yes``: translations are enabled.
+      -  ``no``: translation are disabled.
+
+      The :ref:`ref-classes-gettext` class uses this variable to enable
+      :wikipedia:`Gettext <Gettext>` in recipes that use this class. Recipes can
+      also use the :term:`USE_NLS` variable directly to override the default
+      value of the variable, and configure themselves according to the value of
+      the variable.
+
    :term:`USE_VT`
       When using
       :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`,