Patchwork [PATCHv2,6/6] docs/manual: update documentation about gettext handling

login
register
mail settings
Submitter Thomas Petazzoni
Date June 1, 2014, 8:23 p.m.
Message ID <1401654214-19384-7-git-send-email-thomas.petazzoni@free-electrons.com>
Download mbox | patch
Permalink /patch/354659/
State Superseded
Headers show

Comments

Thomas Petazzoni - June 1, 2014, 8:23 p.m.
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 docs/manual/adding-packages-gettext.txt | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)
Thomas De Schampheleire - June 2, 2014, 5:50 a.m.
Thomas Petazzoni <thomas.petazzoni@free-electrons.com> schreef:
>Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
>---
> docs/manual/adding-packages-gettext.txt | 22 ++++++++++++++++++----
> 1 file changed, 18 insertions(+), 4 deletions(-)
>
>diff --git a/docs/manual/adding-packages-gettext.txt b/docs/manual/adding-packages-gettext.txt
>index d265607..580787f 100644
>--- a/docs/manual/adding-packages-gettext.txt
>+++ b/docs/manual/adding-packages-gettext.txt
>@@ -8,10 +8,16 @@ library. Dependencies for this library are fairly complicated and
> therefore, deserve some explanation.
> 
> The 'uClibc' C library doesn't implement gettext functionality;
>-therefore with this C library, a separate gettext must be compiled. On
>-the other hand, the 'glibc' C library does integrate its own gettext,
>-and in this case the separate gettext library should not be compiled,
>-because it creates various kinds of build failures.
>+therefore with this C library, a separate gettext must be compiled,
>+which will provide the libintl library.
>+
>+On the other hand, the 'glibc' C library does integrate its own
>+gettext library functions, so it is not necessary to build a separate
>+libintl library.
>+
>+However, certain packages will need some gettext utilities on the
>+target, such as the +gettext+ program itself, which allows, from the
>+command line, to retrieve translated strings.

I would reorder as: ... which allows to retrieve translated strings, from the command line.


> 
> Additionally, some packages (such as +libglib2+) do require gettext
> unconditionally, while other packages (those who support
>@@ -44,3 +50,11 @@ should:
> * use +$(if $(BR2_NEEDS_GETTEXT),gettext)+ in the package
>   +DEPENDENCIES+ variable in the +.mk+ file.
> 
>+Packages that need the +gettext+ utilities on the target (should be
>+rare) should:
>+
>+* use +select BR2_PACKAGE_GETTEXT+ in their +Config.in+ file,
>+  indicating in a comment above that it's a runtime dependency only.
>+
>+* not add any dependency to their +.mk+ file +DEPENDENCIES+ variable.

I would clarify: not add any gettext dependency...

Also, it should probably be file's, or rewrite as
... to the DEPENDENCIES variable in their .mk file.

Best regards,
Thomas

Patch

diff --git a/docs/manual/adding-packages-gettext.txt b/docs/manual/adding-packages-gettext.txt
index d265607..580787f 100644
--- a/docs/manual/adding-packages-gettext.txt
+++ b/docs/manual/adding-packages-gettext.txt
@@ -8,10 +8,16 @@  library. Dependencies for this library are fairly complicated and
 therefore, deserve some explanation.
 
 The 'uClibc' C library doesn't implement gettext functionality;
-therefore with this C library, a separate gettext must be compiled. On
-the other hand, the 'glibc' C library does integrate its own gettext,
-and in this case the separate gettext library should not be compiled,
-because it creates various kinds of build failures.
+therefore with this C library, a separate gettext must be compiled,
+which will provide the libintl library.
+
+On the other hand, the 'glibc' C library does integrate its own
+gettext library functions, so it is not necessary to build a separate
+libintl library.
+
+However, certain packages will need some gettext utilities on the
+target, such as the +gettext+ program itself, which allows, from the
+command line, to retrieve translated strings.
 
 Additionally, some packages (such as +libglib2+) do require gettext
 unconditionally, while other packages (those who support
@@ -44,3 +50,11 @@  should:
 * use +$(if $(BR2_NEEDS_GETTEXT),gettext)+ in the package
   +DEPENDENCIES+ variable in the +.mk+ file.
 
+Packages that need the +gettext+ utilities on the target (should be
+rare) should:
+
+* use +select BR2_PACKAGE_GETTEXT+ in their +Config.in+ file,
+  indicating in a comment above that it's a runtime dependency only.
+
+* not add any dependency to their +.mk+ file +DEPENDENCIES+ variable.
+