diff mbox

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

Message ID 1408127999-2352-4-git-send-email-thomas.petazzoni@free-electrons.com
State Superseded
Headers show

Commit Message

Thomas Petazzoni Aug. 15, 2014, 6:39 p.m. UTC
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 docs/manual/adding-packages-gettext.txt | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

Comments

Thomas De Schampheleire Aug. 15, 2014, 7:15 p.m. UTC | #1
Hi Thomas,

On Fri, Aug 15, 2014 at 8:39 PM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
> 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

I would remove 'will' here.

In addition to the above new comment, I already provided feedback on
this patch in June, but you must have missed it:
http://lists.busybox.net/pipermail/buildroot/2014-June/098211.html

Best regards,
Thomas
diff mbox

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.
+