diff mbox series

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

Message ID 20251024-release-note-5-3-second-hunk-v2-11-d15dabc095d0@bootlin.com
State Under Review
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 24, 2025, 8:20 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 | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Quentin Schulz Oct. 24, 2025, 3:36 p.m. UTC | #1
Hi Antonin,

On 10/24/25 10:20 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 | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 34bc7fed8..cd447d2c2 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -968,6 +968,14 @@ 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 build translations *unless*:
> +
> +-  the :term:`USE_NLS` variable is set to ``no``, or
> +
> +-  the :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.

I find two unless in a row difficult to parse, I can suggest:

"""
-  the :term:`INHIBIT_DEFAULT_DEPS` variable is set and the recipe 
inheriting the :ref:`ref-classes-gettext` class does not also inherit 
the :ref:`ref-classes-cross-canadian` class.
"""

Looks good otherwise, thus:

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

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 34bc7fed8..cd447d2c2 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -968,6 +968,14 @@  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 build translations *unless*:
+
+-  the :term:`USE_NLS` variable is set to ``no``, or
+
+-  the :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.
+
 .. _ref-classes-github-releases:
 
 ``github-releases``