mirror of
https://github.com/git/git.git
synced 2024-11-19 00:23:58 +01:00
6cdccfce1e
Change the GETTEXT_POISON compile-time + runtime GIT_GETTEXT_POISON
test parameter to only be a GIT_TEST_GETTEXT_POISON=<non-empty?>
runtime parameter, to be consistent with other parameters documented
in "Running tests with special setups" in t/README.
When I added GETTEXT_POISON in bb946bba76 ("i18n: add GETTEXT_POISON
to simulate unfriendly translator", 2011-02-22) I was concerned with
ensuring that the _() function would get constant folded if NO_GETTEXT
was defined, and likewise that GETTEXT_POISON would be compiled out
unless it was defined.
But as the benchmark in my [1] shows doing a one-off runtime
getenv("GIT_TEST_[...]") is trivial, and since GETTEXT_POISON was
originally added the GIT_TEST_* env variables have become the common
idiom for turning on special test setups.
So change GETTEXT_POISON to work the same way. Now the
GETTEXT_POISON=YesPlease compile-time option is gone, and running the
tests with GIT_TEST_GETTEXT_POISON=[YesPlease|] can be toggled on/off
without recompiling.
This allows for conditionally amending tests to test with/without
poison, similar to what 859fdc0c3c ("commit-graph: define
GIT_TEST_COMMIT_GRAPH", 2018-08-29) did for GIT_TEST_COMMIT_GRAPH. Do
some of that, now we e.g. always run the t0205-gettext-poison.sh test.
I did enough there to remove the GETTEXT_POISON prerequisite, but its
inverse C_LOCALE_OUTPUT is still around, and surely some tests using
it can be converted to e.g. always set GIT_TEST_GETTEXT_POISON=.
Notes on the implementation:
* We still compile a dedicated GETTEXT_POISON build in Travis
CI. Perhaps this should be revisited and integrated into the
"linux-gcc" build, see ae59a4e44f ("travis: run tests with
GIT_TEST_SPLIT_INDEX", 2018-01-07) for prior art in that area. Then
again maybe not, see [2].
* We now skip a test in t0000-basic.sh under
GIT_TEST_GETTEXT_POISON=YesPlease that wasn't skipped before. This
test relies on C locale output, but due to an edge case in how the
previous implementation of GETTEXT_POISON worked (reading it from
GIT-BUILD-OPTIONS) wasn't enabling poison correctly. Now it does,
and needs to be skipped.
* The getenv() function is not reentrant, so out of paranoia about
code of the form:
printf(_("%s"), getenv("some-env"));
call use_gettext_poison() in our early setup in git_setup_gettext()
so we populate the "poison_requested" variable in a codepath that's
won't suffer from that race condition.
* We error out in the Makefile if you're still saying
GETTEXT_POISON=YesPlease to prompt users to change their
invocation.
* We should not print out poisoned messages during the test
initialization itself to keep it more readable, so the test library
hides the variable if set in $GIT_TEST_GETTEXT_POISON_ORIG during
setup. See [3].
See also [4] for more on the motivation behind this patch, and the
history of the GETTEXT_POISON facility.
1. https://public-inbox.org/git/871s8gd32p.fsf@evledraar.gmail.com/
2. https://public-inbox.org/git/20181102163725.GY30222@szeder.dev/
3. https://public-inbox.org/git/20181022202241.18629-2-szeder.dev@gmail.com/
4. https://public-inbox.org/git/878t2pd6yu.fsf@evledraar.gmail.com/
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
110 lines
2.3 KiB
Bash
110 lines
2.3 KiB
Bash
# This shell library is Git's interface to gettext.sh. See po/README
|
|
# for usage instructions.
|
|
#
|
|
# Copyright (c) 2010 Ævar Arnfjörð Bjarmason
|
|
#
|
|
|
|
# Export the TEXTDOMAIN* data that we need for Git
|
|
TEXTDOMAIN=git
|
|
export TEXTDOMAIN
|
|
if test -z "$GIT_TEXTDOMAINDIR"
|
|
then
|
|
TEXTDOMAINDIR="@@LOCALEDIR@@"
|
|
else
|
|
TEXTDOMAINDIR="$GIT_TEXTDOMAINDIR"
|
|
fi
|
|
export TEXTDOMAINDIR
|
|
|
|
# First decide what scheme to use...
|
|
GIT_INTERNAL_GETTEXT_SH_SCHEME=fallthrough
|
|
if test -n "$GIT_TEST_GETTEXT_POISON"
|
|
then
|
|
GIT_INTERNAL_GETTEXT_SH_SCHEME=poison
|
|
elif test -n "@@USE_GETTEXT_SCHEME@@"
|
|
then
|
|
GIT_INTERNAL_GETTEXT_SH_SCHEME="@@USE_GETTEXT_SCHEME@@"
|
|
elif test -n "$GIT_INTERNAL_GETTEXT_TEST_FALLBACKS"
|
|
then
|
|
: no probing necessary
|
|
elif type gettext.sh >/dev/null 2>&1
|
|
then
|
|
# GNU libintl's gettext.sh
|
|
GIT_INTERNAL_GETTEXT_SH_SCHEME=gnu
|
|
elif test "$(gettext -h 2>&1)" = "-h"
|
|
then
|
|
# gettext binary exists but no gettext.sh. likely to be a gettext
|
|
# binary on a Solaris or something that is not GNU libintl and
|
|
# lack eval_gettext.
|
|
GIT_INTERNAL_GETTEXT_SH_SCHEME=gettext_without_eval_gettext
|
|
fi
|
|
export GIT_INTERNAL_GETTEXT_SH_SCHEME
|
|
|
|
# ... and then follow that decision.
|
|
case "$GIT_INTERNAL_GETTEXT_SH_SCHEME" in
|
|
gnu)
|
|
# Use libintl's gettext.sh, or fall back to English if we can't.
|
|
. gettext.sh
|
|
;;
|
|
gettext_without_eval_gettext)
|
|
# Solaris has a gettext(1) but no eval_gettext(1)
|
|
eval_gettext () {
|
|
gettext "$1" | (
|
|
export PATH $(git sh-i18n--envsubst --variables "$1");
|
|
git sh-i18n--envsubst "$1"
|
|
)
|
|
}
|
|
|
|
eval_ngettext () {
|
|
ngettext "$1" "$2" "$3" | (
|
|
export PATH $(git sh-i18n--envsubst --variables "$2");
|
|
git sh-i18n--envsubst "$2"
|
|
)
|
|
}
|
|
;;
|
|
poison)
|
|
# Emit garbage so that tests that incorrectly rely on translatable
|
|
# strings will fail.
|
|
gettext () {
|
|
printf "%s" "# GETTEXT POISON #"
|
|
}
|
|
|
|
eval_gettext () {
|
|
printf "%s" "# GETTEXT POISON #"
|
|
}
|
|
|
|
eval_ngettext () {
|
|
printf "%s" "# GETTEXT POISON #"
|
|
}
|
|
;;
|
|
*)
|
|
gettext () {
|
|
printf "%s" "$1"
|
|
}
|
|
|
|
eval_gettext () {
|
|
printf "%s" "$1" | (
|
|
export PATH $(git sh-i18n--envsubst --variables "$1");
|
|
git sh-i18n--envsubst "$1"
|
|
)
|
|
}
|
|
|
|
eval_ngettext () {
|
|
(test "$3" = 1 && printf "%s" "$1" || printf "%s" "$2") | (
|
|
export PATH $(git sh-i18n--envsubst --variables "$2");
|
|
git sh-i18n--envsubst "$2"
|
|
)
|
|
}
|
|
;;
|
|
esac
|
|
|
|
# Git-specific wrapper functions
|
|
gettextln () {
|
|
gettext "$1"
|
|
echo
|
|
}
|
|
|
|
eval_gettextln () {
|
|
eval_gettext "$1"
|
|
echo
|
|
}
|