This patch reverts the use of pygettext for i18n string extraction. It
was originally introduced because the help documentation for commands
are in the class docstring and module docstring.
Docstrings are a Python construct whereby any string which immediately
follows a class declaration, function/method declaration or appears
first in a module is taken to be the documentation for that
object. Python automatically assigns that string to the __doc__
variable associated with the object. Explicitly assigning to the
__doc__ variable is equivalent and permitted.
We mark strings in the source for i18n translation by embedding them
in _() or ngettext(). Specialized extraction tools (e.g. xgettext)
scan the source code looking for strings with those markers and
extracts the string for inclusion in a translation catalog.
It was mistakingly assumed one could not mark for translation Python
docstrings. Since some docstrings are vital for our command help
system some method had to be devised to extract docstrings for the
translation catalog. pygettext has the ability to locate and extract
docstrings and it was introduced to acquire the documentation for our
commands located in module and class docstrings.
However pygettext was too large a hammer for this task, it lacked any
fined grained ability to extract only the docstrings we were
interested in. In practice it extracted EVERY docstring in each file
it was presented with. This caused a large number strings to be
extracted for translation which had no reason to be translated, the
string might have been internal code documentation never meant to be
seen by users. Often the superfluous docstrings were long, complex and
likely difficult to translate. This placed an unnecessary burden on
our volunteer translators.
Instead what is needed is some method to extract only those strings
intended for translation. We already have such a mechanism and it is
already widely used, namely wrapping strings intended for translation
in calls to _() or _negettext(), i.e. marking a string for i18n
translation. Thus the solution to the docstring translation problem is
to mark the docstrings exactly as we have been doing, it only requires
that instead of a bare Python docstring we instead assign the marked
string to the __doc__ variable. Using the hypothetical class foo as
an example.
class foo(Command):
'''
The foo command takes out the garbage.
'''
Would become:
class foo(Command):
__doc__ = _('The foo command takes out the garbage.')
But which docstrings need to be marked for translation? The makeapi
tool knows how to iterate over every command in our public API. It was
extended to validate every command's documentation and report if any
documentation is missing or not marked for translation. That
information was then used to identify each docstring in the code which
needed to be transformed.
In summary what this patch does is:
* Remove the use of pygettext (modification to install/po/Makefile.in)
* Replace every docstring with an explicit assignment to __doc__ where
the rhs of the assignment is an i18n marking function.
* Single line docstrings appearing in multi-line string literals
(e.g. ''' or """) were replaced with single line string literals
because the multi-line literals were introducing unnecessary
whitespace and newlines in the string extracted for translation. For
example:
'''
The foo command takes out the garbage.
'''
Would appear in the translation catalog as:
"\n
The foo command takes out the garbage.\n
"
The superfluous whitespace and newlines are confusing to translators
and requires us to strip leading and trailing whitespace from the
translation at run time.
* Import statements were moved from below the docstring to above
it. This was necessary because the i18n markers are imported
functions and must be available before the the doc is
parsed. Technically only the import of the i18n markers had to
appear before the doc but stylistically it's better to keep all the
imports together.
* It was observed during the docstring editing process that the
command documentation was inconsistent with respect to the use of
periods to terminate a sentence. Some doc had a trailing period,
others didn't. Consistency was enforced by adding a period to end of
every docstring if one was missing.
ticket 1650 (https://fedorahosted.org/freeipa/ticket/1650) has an extensive discussion of the issues, please refer to that. This patch does the following: * does not count fuzzy translations when computing translation statistics via the "msg-stats" make target in install/po * adds a new make target called "pull-po" which pulls updated po files from Transifex (configure.ac includes some trailing whitespace fixes) * turns off the generation of fuzzy translation suggestions during the message merge phase.
After updating po's current translation status is: ipa.pot has 1329 messages. There are 21 po translation files. as: 0/1329 0.0% 1329 untranslated, 0 fuzzy bn_IN: 13/1329 1.0% 1316 untranslated, 0 fuzzy zh_CN: 133/1329 10.0% 1196 untranslated, 0 fuzzy zh_TW: 0/1329 0.0% 1329 untranslated, 0 fuzzy nl: 1/1329 0.1% 1328 untranslated, 0 fuzzy fr: 0/1329 0.0% 1329 untranslated, 0 fuzzy de: 27/1329 2.0% 1302 untranslated, 0 fuzzy el: 0/1329 0.0% 1329 untranslated, 0 fuzzy gu: 0/1329 0.0% 1329 untranslated, 0 fuzzy id: 89/1329 6.7% 1240 untranslated, 0 fuzzy ja_JP: 0/1329 0.0% 1329 untranslated, 0 fuzzy ja: 0/1329 0.0% 1329 untranslated, 0 fuzzy kn: 243/1329 18.3% 1086 untranslated, 0 fuzzy fa: 0/1329 0.0% 1329 untranslated, 0 fuzzy pl: 492/1329 37.0% 837 untranslated, 0 fuzzy pt_BR: 0/1329 0.0% 1329 untranslated, 0 fuzzy pt: 0/1329 0.0% 1329 untranslated, 0 fuzzy ru: 162/1329 12.2% 1167 untranslated, 0 fuzzy es: 1329/1329 100.0% 0 untranslated, 0 fuzzy sv: 0/1329 0.0% 1329 untranslated, 0 fuzzy uk: 1329/1329 100.0% 0 untranslated, 0 fuzzy
Our LINGUAS file and the set of po files have diverged from what's on Transifex. We should update the LINGUAS file to match the set of translations on Transifex and add po files currently on Transifex but not in our git repo to our git repo.
Pull the new translations for Spanish (es) and Ukrainian (uk) Update the LINGUAS file to add comment showing the friendly name for the language abbreviation. The make target msg-stats which produces a report about the state of the translations no longer maintained it's column alignment due to larger numbers so the formating was tweaked to maintain column alignment.
A dogtag replica file is created as usual. When the replica is installed dogtag is optional and not installed by default. Adding the --setup-ca option will configure it when the replica is installed. A new tool ipa-ca-install will configure dogtag if it wasn't configured when the replica was initially installed. This moves a fair bit of code out of ipa-replica-install into installutils and cainstance to avoid duplication. https://fedorahosted.org/freeipa/ticket/1251
When connection between a master machine and future replica is not
sane, the replica installation may fail unexpectedly with
inconvenient error messages. One common problem is misconfigured
firewall.
This patch adds a program ipa-replica-conncheck which tests the
connection using the following procedure:
1) Execute the on-replica check testing the connection to master
2) Open required ports on local machine
3) Ask user to run the on-master part of the check OR run it
automatically:
a) kinit to master as default admin user with given password
b) run the on-master part using ssh
4) When master part is executed, it checks connection back to
the replica and prints the check result
This program is run by ipa-replica-install as mandatory part. It
can, however, be skipped using --skip-conncheck option.
ipa-replica-install now requires password for admin user to run
the command on remote master.
https://fedorahosted.org/freeipa/ticket/1107
Report missing python packages, inform about false positives, fail gracefully if pylint isn't installed. Fixed a bug in the ignore list and added few more files/directories to it. ticket 1184
Disable pylint error _ undefined in i18n tests Fix missing os import in ipa-nis-manage