logo_kerberos.gif

Difference between revisions of "Projects/Localization"

From K5Wiki
Jump to: navigation, search
(New page: {{project-early}} {{project-target|1.10}} ==Overview== The purpose of this project is to add infrastructure for localization of user interface messages in the krb5 tree, using gettext. ...)
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{project-early}}
 +
{{project-rel|1.10}}
−
{{project-target|1.10}}
  
   
 
==Overview==
  
==Overview==
Line 7: Line 7:
 
==Design==
  
==Design==
   
−
A single text domain, mit-krb5, will be used for all messages.
  
  +
===Basic infrastructure===
   
⚫
krb5_init_context() will be extended to call bindtextdomain() for the mit-krb5 textdomain when built with localization support.
  
  +
Configuration logic will be added to build with localization support if <libintl.h> is available on the system. The system library -lintl will be used if libc does not define dgettext().
   
−
Strings in the tree which should be translated will be marked up with _(), which will be defined to dgettext("mit-krb5", string) when built with localization support.
 +
Macros will be added to k5-platform.h to define _() and N_(), and to null out calls to bindtextdomain(), setlocale(), and dgettext() when krb5 is built without localization support.
   
−
com_err messages will be translated in krb5_get_error_message(). This will not reach direct uses of the com_err library, but will work when krb5 is built against an external com_err library. Any direct uses of error_message() or com_err() without an appropriate hook should be identified and corrected.
  
  +
Strings in the tree which should be translated will be marked up with _(), which will be defined to dgettext("mit-krb5", string) when built with localization support. Strings which will be translated later will be marked up with N_().
   
−
Build infrastructure will be added to run xgettext to extract marked strings. For com_err tables, we can either run xgettext over the generated source files in the build tree, or extend compile_et to generate pot file entries. Further investigation is required to determine the simplest approach.
  
  ⚫
krb5int_lib_init() will be extended to call bindtextdomain() for the mit-krb5 textdomain.
   
−
Programs in the tree such as kinit will call setlocale() at startup.
  
  +
Build infrastructure will be added to run xgettext to extract marked strings from C source files into a pot file, and to convert po files into mo files and install them. A placeholder en_US.po file with no translations will be used to make the build infrastructure work until there are actual translations to ship.
  +
  +
Programs in the tree such as kinit will call setlocale(LC_MESSAGES, "") at startup. For now we will not use LC_ALL to avoid possible unwanted impacts on the processing of protocol data using ctype.h macros or similar functions.
   
 
The test framework will be modified to set the locale to C to ensure that it sees the expected (untranslated) output.
  
The test framework will be modified to set the locale to C to ensure that it sees the expected (untranslated) output.
  +
  +
===com_err library===
  +
  +
There are several versions of the com_err library. MIT krb5 is typically built either with its own internal version of com_err, or with the system com_err which typically comes from e2fsprogs. The following changes will be made to the internal krb5 com_err and have also been submitted to the e2fsprogs maintainer for its version of com_err:
  +
  +
* compile_et defines N_() to a no-op and marks up error message strings with it.
  +
* If compile_et is passed the --textdomain option, it stores the text domain as a string at the end of the error table, before the null terminator.
  +
* If compile_et is also passed the --localedir option, it stores it in the error table after the text domain.
  +
* If an error table has a text domain, error_message() will call dgettext on the text domain and error string.
  +
* If an error table also has a locale directory, add_error_table() will call bindtextdomain on the text domain and locale direcetory.
  +
  +
We will use the --textdomain option, but not the --localedir option. If we build against a system com_err with no support for compile_et --textdomain, we will translate com_err results in krb5int_get_error(), which should reach most uses.
  +
  +
===Markup===
  +
  +
A pass will be made over the source tree looking for strings, each of which is analyzed to determine if it is a string presented to the user on stdout or stderr or a log file. If so, it will be marked for translating. Messages sent over a network protocol will not be marked for translation, as we generally do not know the locale of the client (nor does gettext provide easy way to localize messages for different clients in different locales). A few messages will be skipped for now because they are part of tables, and translating them would disturb table alignment.
   
 
==Relevant Mailing List Threads==
  
==Relevant Mailing List Threads==
   
 
http://mailman.mit.edu/pipermail/krbdev/2011-May/010011.html
  
http://mailman.mit.edu/pipermail/krbdev/2011-May/010011.html
  +
  +
==Release notes==
  +
  +
End-user experience:
  +
  +
* Add support for localization. (No translations are provided in this release, but the infrastructure is present for redistributors to supply them.)

Latest revision as of 16:49, 12 October 2011

This project was completed in release 1.10.


Overview

The purpose of this project is to add infrastructure for localization of user interface messages in the krb5 tree, using gettext.

Design

Basic infrastructure

Configuration logic will be added to build with localization support if <libintl.h> is available on the system. The system library -lintl will be used if libc does not define dgettext().

Macros will be added to k5-platform.h to define _() and N_(), and to null out calls to bindtextdomain(), setlocale(), and dgettext() when krb5 is built without localization support.

Strings in the tree which should be translated will be marked up with _(), which will be defined to dgettext("mit-krb5", string) when built with localization support. Strings which will be translated later will be marked up with N_().

krb5int_lib_init() will be extended to call bindtextdomain() for the mit-krb5 textdomain.

Build infrastructure will be added to run xgettext to extract marked strings from C source files into a pot file, and to convert po files into mo files and install them. A placeholder en_US.po file with no translations will be used to make the build infrastructure work until there are actual translations to ship.

Programs in the tree such as kinit will call setlocale(LC_MESSAGES, "") at startup. For now we will not use LC_ALL to avoid possible unwanted impacts on the processing of protocol data using ctype.h macros or similar functions.

The test framework will be modified to set the locale to C to ensure that it sees the expected (untranslated) output.

com_err library

There are several versions of the com_err library. MIT krb5 is typically built either with its own internal version of com_err, or with the system com_err which typically comes from e2fsprogs. The following changes will be made to the internal krb5 com_err and have also been submitted to the e2fsprogs maintainer for its version of com_err:

  • compile_et defines N_() to a no-op and marks up error message strings with it.
  • If compile_et is passed the --textdomain option, it stores the text domain as a string at the end of the error table, before the null terminator.
  • If compile_et is also passed the --localedir option, it stores it in the error table after the text domain.
  • If an error table has a text domain, error_message() will call dgettext on the text domain and error string.
  • If an error table also has a locale directory, add_error_table() will call bindtextdomain on the text domain and locale direcetory.

We will use the --textdomain option, but not the --localedir option. If we build against a system com_err with no support for compile_et --textdomain, we will translate com_err results in krb5int_get_error(), which should reach most uses.

Markup

A pass will be made over the source tree looking for strings, each of which is analyzed to determine if it is a string presented to the user on stdout or stderr or a log file. If so, it will be marked for translating. Messages sent over a network protocol will not be marked for translation, as we generally do not know the locale of the client (nor does gettext provide easy way to localize messages for different clients in different locales). A few messages will be skipped for now because they are part of tables, and translating them would disturb table alignment.

Relevant Mailing List Threads

http://mailman.mit.edu/pipermail/krbdev/2011-May/010011.html

Release notes

End-user experience:

  • Add support for localization. (No translations are provided in this release, but the infrastructure is present for redistributors to supply them.)
Retrieved from "https://k5wiki.kerberos.org/wiki?title=Projects/Localization&oldid=4120"