examples: Drop unnecessary $(mkinstalldirs) call
[libvirt/ericb.git] / po / README.md
blob71b5793a2d7ac49a916a58a1cde37808e402abcc
1 Libvirt Message Translation
2 ===========================
4 Libvirt translatable messages are maintained using the GNU Gettext tools and
5 file formats, in combination with the Zanata web service.
7 Source repository
8 =================
10 The libvirt GIT repository does NOT store the master "libvirt.pot" file, nor
11 does it store full "po" files for translations. The master "libvirt.pot" file
12 can be generated at any time using
14    make libvirt.pot
16 The translations are kept in minimized files that are the same file format
17 as normal po files but with all redundant information stripped and messages
18 re-ordered. The key differences between the ".mini.po" files in GIT and the
19 full ".po" files are
21   - msgids with no current translation are omitted
22   - msgids are sorted in alphabetical order not source file order
23   - msgids with a msgstr marked "fuzzy" are discarded
24   - source file locations are omitted
26 The full po files can be created at any time using
28    make update-po
30 This merges the "libvirt.pot" with the "$LANG.mini.po" for each language, to
31 create the "$LANG.po" files. These are included in the release archives created
32 by "make dist".
34 When a full po file is updated, changes can be propagated back into the
35 minimized po files using
37    make update-mini-po
39 Note, however, that this is generally not something that should be run by
40 developers normally, as it is triggered by 'make pull-po' when refreshing
41 content from Zanata.
44 Zanata web service
45 ==================
47 The translation of libvirt messages has been outsourced to the Fedora
48 translation team using the Zanata web service:
50   https://fedora.zanata.org/project/view/libvirt
52 As such, changes to translations will generally NOT be accepted as patches
53 directly to libvirt GIT. Any changes made to "$LANG.mini.po" files in libvirt
54 GIT will be overwritten and lost the next time content is imported from Zanata.
56 The master "libvirt.pot" file is periodically pushed to Zanata to provide the
57 translation team with content changes, using
59   make push-pot
61 New translated text is then periodically pulled down from Zanata to update the
62 minimized po files, using
64   make pull-po
66 Sometimes the translators make mistakes, most commonly with handling printf
67 format specifiers. The "pull-po" command re-generates the .gmo files to try to
68 identify such mistakes. If a mistake is made, the broken msgstr should be
69 deleted in the local "$LANG.mini.po" file, and the Zanata web interface used
70 to reject the translation so that the broken msgstr isn't pulled down next time.
72 After pulling down new content the diff should be examined to look for any
73 obvious mistakes that are not caught automatically. There have been bugs in
74 Zanata tools which caused messges to go missing, so pay particular attention to
75 diffs showing deletions where the msgid still exists in libvirt.pot