Skip to content
  • Ævar Arnfjörð Bjarmason's avatar
    i18n: add infrastructure for translating Git with gettext · 5e9637c6
    Ævar Arnfjörð Bjarmason authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    Change the skeleton implementation of i18n in Git to one that can show
    localized strings to users for our C, Shell and Perl programs using
    either GNU libintl or the Solaris gettext implementation.
    
    This new internationalization support is enabled by default. If
    gettext isn't available, or if Git is compiled with
    NO_GETTEXT=YesPlease, Git falls back on its current behavior of
    showing interface messages in English. When using the autoconf script
    we'll auto-detect if the gettext libraries are installed and act
    appropriately.
    
    This change is somewhat large because as well as adding a C, Shell and
    Perl i18n interface we're adding a lot of tests for them, and for
    those tests to work we need a skeleton PO file to actually test
    translations. A minimal Icelandic translation is included for this
    purpose. Icelandic includes multi-byte characters which makes it easy
    to test various edge cases, and it's a language I happen to
    understand.
    
    The rest of the commit message goes into detail about various
    sub-parts of this commit.
    
    = Installation
    
    Gettext .mo files will be installed and looked for in the standard
    $(prefix)/share/locale path. GIT_TEXTDOMAINDIR can also be set to
    override that, but that's only intended to be used to test Git itself.
    
    = Perl
    
    Perl code that's to be localized should use the new Git::I18n
    module. It imports a __ function into the caller's package by default.
    
    Instead of using the high level Locale::TextDomain interface I've
    opted to use the low-level (equivalent to the C interface)
    Locale::Messages module, which Locale::TextDomain itself uses.
    
    Locale::TextDomain does a lot of redundant work we don't need, and
    some of it would potentially introduce bugs. It tries to set the
    $TEXTDOMAIN based on package of the caller, and has its own
    hardcoded paths where it'll search for messages.
    
    I found it easier just to completely avoid it rather than try to
    circumvent its behavior. In any case, this is an issue wholly
    internal Git::I18N. Its guts can be changed later if that's deemed
    necessary.
    
    See <AANLkTilYD_NyIZMyj9dHtVk-ylVBfvyxpCC7982LWnVd@mail.gmail.com> for
    a further elaboration on this topic.
    
    = Shell
    
    Shell code that's to be localized should use the git-sh-i18n
    library. It's basically just a wrapper for the system's gettext.sh.
    
    If gettext.sh isn't available we'll fall back on gettext(1) if it's
    available. The latter is available without the former on Solaris,
    which has its own non-GNU gettext implementation. We also need to
    emulate eval_gettext() there.
    
    If neither are present we'll use a dumb printf(1) fall-through
    wrapper.
    
    = About libcharset.h and langinfo.h
    
    We use libcharset to query the character set of the current locale if
    it's available. I.e. we'll use it instead of nl_langinfo if
    HAVE_LIBCHARSET_H is set.
    
    The GNU gettext manual recommends using langinfo.h's
    nl_langinfo(CODESET) to acquire the current character set, but on
    systems that have libcharset.h's locale_charset() using the latter is
    either saner, or the only option on those systems.
    
    GNU and Solaris have a nl_langinfo(CODESET), FreeBSD can use either,
    but MinGW and some others need to use libcharset.h's locale_charset()
    instead.
    
    =Credits
    
    This patch is based on work by Jeff Epler <jepler@unpythonic.net> who
    did the initial Makefile / C work, and a lot of comments from the Git
    mailing list, including Jonathan Nieder, Jakub Narebski, Johannes
    Sixt, Erik Faye-Lund, Peter Krefting, Junio C Hamano, Thomas Rast and
    others.
    
    [jc: squashed a small Makefile fix from Ramsay]
    
    Signed-off-by: default avatarÆvar Arnfjörð Bjarmason <avarab@gmail.com>
    Signed-off-by: default avatarRamsay Jones <ramsay@ramsay1.demon.co.uk>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    5e9637c6