diff mbox series

[11/17] ref-manual/classes.rst: gettext: extend the documentation of the class

Message ID 20251016-release-note-5-3-second-hunk-v1-11-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
Mention the use of USE_NLS, INHIBIT_DEFAULT_DEPS and the cross-canadian
class.

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

Comments

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

On 10/16/25 10:54 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Mention the use of USE_NLS, INHIBIT_DEFAULT_DEPS and the cross-canadian
> class.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/classes.rst | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 68edbc9dd..d898034f4 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -968,6 +968,11 @@ software that uses the GNU ``gettext`` internationalization and localization
>   system. All recipes building software that use ``gettext`` should inherit this
>   class.
>   
> +This class will configure recipes to *not* build translations if the
> +:term:`USE_NLS` variable is set to ``no``. It will also do the same if the
> +:term:`INHIBIT_DEFAULT_DEPS` variable is set (unless the recipe inheriting the
> +class also inherits the :ref:`ref-classes-cross-canadian` class).
> +

I think using a list here would help with readability, e.g.:

"""
This class will configure recipes to *not* build translations if either:

- :term:`USE_NLS` variable is set to ``no``, or
- :term:`INHIBIT_DEFAULT_DEPS` variable is set, unless the recipe 
inheriting the :ref:`ref-classes-gettext` class also inherits the 
:ref:`ref-classes-cross-canadian` class.
"""

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
Paul Barker Oct. 16, 2025, 10:38 a.m. UTC | #2
On Thu, 2025-10-16 at 10:54 +0200, Antonin Godard wrote:
> Mention the use of USE_NLS, INHIBIT_DEFAULT_DEPS and the cross-canadian
> class.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>  documentation/ref-manual/classes.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 68edbc9dd..d898034f4 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -968,6 +968,11 @@ software that uses the GNU ``gettext`` internationalization and localization
>  system. All recipes building software that use ``gettext`` should inherit this
>  class.
>  
> +This class will configure recipes to *not* build translations if the
> +:term:`USE_NLS` variable is set to ``no``. It will also do the same if the
> +:term:`INHIBIT_DEFAULT_DEPS` variable is set (unless the recipe inheriting the
> +class also inherits the :ref:`ref-classes-cross-canadian` class).
> +

I think the first sentence here is clearer if we say it the other way
around:

This class will configure recipes to build translations *unless* the
:term:`USE_NLS` variable is set to "no".

Thanks,
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 68edbc9dd..d898034f4 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -968,6 +968,11 @@  software that uses the GNU ``gettext`` internationalization and localization
 system. All recipes building software that use ``gettext`` should inherit this
 class.
 
+This class will configure recipes to *not* build translations if the
+:term:`USE_NLS` variable is set to ``no``. It will also do the same if the
+:term:`INHIBIT_DEFAULT_DEPS` variable is set (unless the recipe inheriting the
+class also inherits the :ref:`ref-classes-cross-canadian` class).
+
 .. _ref-classes-github-releases:
 
 ``github-releases``