Mailing List Archive

Ever since the L10N USE_EXPAND variable was introduced, the name of
this eclass was somewhat confusing, because it operates on LINGUAS and
is unrelated to L10N. Take the EAPI 8 bump as an opportunity to rename
the eclass.

Signed-off-by: Ulrich Müller <ulm@gentoo.org>
---
eclass/{l10n.eclass => plocale.eclass} | 78 +++++++++++++-------------
1 file changed, 38 insertions(+), 40 deletions(-)
copy eclass/{l10n.eclass => plocale.eclass} (61%)

diff --git a/eclass/l10n.eclass b/eclass/plocale.eclass
similarity index 61%
copy from eclass/l10n.eclass
copy to eclass/plocale.eclass
index cd859429d8c7..81f147a655ed 100644
--- a/eclass/l10n.eclass
+++ b/eclass/plocale.eclass
@@ -1,29 +1,27 @@
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 2012-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

-# @ECLASS: l10n.eclass
+# @ECLASS: plocale.eclass
# @MAINTAINER:
# Ulrich Müller <ulm@gentoo.org>
# @AUTHOR:
# Ben de Groot <yngwin@gentoo.org>
-# @SUPPORTED_EAPIS: 5 6 7
+# @SUPPORTED_EAPIS: 6 7 8
# @BLURB: convenience functions to handle localizations
# @DESCRIPTION:
-# The l10n (localization) eclass offers a number of functions to more
+# The plocale (localization) eclass offers a number of functions to more
# conveniently handle localizations (translations) offered by packages.
# These are meant to prevent code duplication for such boring tasks as
# determining the cross-section between the user's set LINGUAS and what
# is offered by the package.

-case ${EAPI:-0} in
- [567]) ;;
+case ${EAPI} in
+ 6|7|8) ;;
*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
esac

-inherit strip-linguas
-
-if [[ -z ${_L10N_ECLASS} ]]; then
-_L10N_ECLASS=1
+if [[ -z ${_PLOCALE_ECLASS} ]]; then
+_PLOCALE_ECLASS=1

# @ECLASS-VARIABLE: PLOCALES
# @DEFAULT_UNSET
@@ -37,81 +35,81 @@ _L10N_ECLASS=1
# @DEFAULT_UNSET
# @DESCRIPTION:
# In some cases the package fails when none of the offered PLOCALES are
-# selected by the user. In that case this variable should be set to a
+# selected by the user. In that case this variable should be set to a
# default locale (usually 'en' or 'en_US') as backup.
#
# Example: PLOCALE_BACKUP="en_US"

-# @FUNCTION: l10n_for_each_locale_do
+# @FUNCTION: plocale_for_each_locale
# @USAGE: <function>
# @DESCRIPTION:
-# Convenience function for processing localizations. The parameter should
-# be a function (defined in the consuming eclass or ebuild) which takes
-# an individual localization as (last) parameter.
+# Convenience function for processing all enabled localizations.
+# The parameter should be a function (defined in the consuming eclass
+# or ebuild) which takes an individual locale as its (last) parameter.
#
-# Example: l10n_for_each_locale_do install_locale
-l10n_for_each_locale_do() {
+# Example: plocale_for_each_locale install_locale
+plocale_for_each_locale() {
local locs x
- locs=$(l10n_get_locales)
+ locs=$(plocale_get_locales)
for x in ${locs}; do
- "${@}" ${x} || die "failed to process enabled ${x} locale"
+ "$@" ${x} || die "failed to process enabled ${x} locale"
done
}

-# @FUNCTION: l10n_for_each_disabled_locale_do
+# @FUNCTION: plocale_for_each_disabled_locale
# @USAGE: <function>
# @DESCRIPTION:
-# Complementary to l10n_for_each_locale_do, this function will process
-# locales that are disabled. This could be used for example to remove
+# Complementary to plocale_for_each_locale, this function will process
+# locales that are disabled. This could be used for example to remove
# locales from a Makefile, to prevent them from being built needlessly.
-l10n_for_each_disabled_locale_do() {
+plocale_for_each_disabled_locale() {
local locs x
- locs=$(l10n_get_locales disabled)
+ locs=$(plocale_get_locales disabled)
for x in ${locs}; do
- "${@}" ${x} || die "failed to process disabled ${x} locale"
+ "$@" ${x} || die "failed to process disabled ${x} locale"
done
}

-# @FUNCTION: l10n_find_plocales_changes
+# @FUNCTION: plocale_find_changes
# @USAGE: <translations dir> <filename pre pattern> <filename post pattern>
# @DESCRIPTION:
# Ebuild maintenance helper function to find changes in package offered
-# locales when doing a version bump. This could be added for example to
-# src_prepare
+# locales when doing a version bump. This could be added for example
+# to src_prepare.
#
-# Example: l10n_find_plocales_changes "${S}/src/translations" "${PN}_" '.ts'
-l10n_find_plocales_changes() {
- [[ $# -ne 3 ]] && die "Exactly 3 arguments are needed!"
+# Example: plocale_find_changes "${S}/src/translations" "${PN}_" '.ts'
+plocale_find_changes() {
+ [[ $# -eq 3 ]] || die "Exactly 3 arguments are needed!"
ebegin "Looking in ${1} for new locales"
pushd "${1}" >/dev/null || die "Cannot access ${1}"
- local current= x=
- for x in ${2}*${3} ; do
+ local current="" x
+ for x in ${2}*${3}; do
x=${x#"${2}"}
x=${x%"${3}"}
current+="${x} "
done
- popd >/dev/null
+ popd >/dev/null || die
# RHS will be sorted with single spaces so ensure the LHS is too
# before attempting to compare them for equality. See bug #513242.
# Run them both through the same sorting algorithm so we don't have
# to worry about them being the same.
- if [[ "$(printf '%s\n' ${PLOCALES} | LC_ALL=C sort)" != "$(printf '%s\n' ${current} | LC_ALL=C sort)" ]] ; then
- eend 1 "There are changes in locales! This ebuild should be updated to:"
+ [[ "$(printf '%s\n' ${PLOCALES} | LC_ALL=C sort)" \
+ == "$(printf '%s\n' ${current} | LC_ALL=C sort)" ]]
+ if ! eend $? "There are changes in locales!"; then
+ eerror "This ebuild should be updated to:"
eerror "PLOCALES=\"${current%[[:space:]]}\""
return 1
- else
- eend 0
fi
}

-# @FUNCTION: l10n_get_locales
+# @FUNCTION: plocale_get_locales
# @USAGE: [disabled]
# @DESCRIPTION:
# Determine which LINGUAS the user has enabled that are offered by the
# package, as listed in PLOCALES, and return them. In case no locales
# are selected, fall back on PLOCALE_BACKUP. When the disabled argument
# is given, return the disabled locales instead of the enabled ones.
-l10n_get_locales() {
+plocale_get_locales() {
local loc locs
if [[ -z ${LINGUAS+set} ]]; then
# enable all if unset
--
2.32.0