]> err.no Git - dpkg/blob - README.translators
Merge commit 'err.no/master'
[dpkg] / README.translators
1 Translators, when adding/updating your translation files, please follow
2 the following rules:
3
4 * Update debian/changelog and one of po/ChangeLog, dselect/po/ChangeLog,
5   scripts/ChangeLog or man/ChangeLog:
6
7   - Beware the you should NOT update the main ChangeLog file
8     for translation updates. Use the ChangeLog in the relevant
9     subdirectory instead.
10
11   - The format of entries in the subdirectories' ChangeLog is strict:
12
13 ==========================================================
14 2006-02-11  Christian Perrier  <bubulle@debian.org>
15
16         * fr.po: Updated to 1011t.
17 ==========================================================
18
19     Note the date format AND the DOUBLE SPACE between the date and the
20     translator's email address.
21
22     Note also the TAB character before the entry. NOT multiple spaces.
23
24     Also note that the update should mention the file statistics as
25     XXXtYYYfZZZu.
26
27     "XXXt" means "XXX translated strings".
28     "YYYf" means "YYY fuzzy strings strings".
29     "ZZZu" means "ZZZ untranslated strings".
30     YYY or ZZZ may be omitted if they are null.
31
32     This file contents MUST be encoded in UTF-8.
33
34 * Format of entries in debian/changelog:
35
36   Translation updates should go in a dedicated "[ Updated Translations ]"
37   section:
38
39 ==========================================================
40 dpkg (1.13.15) unstable; urgency=low
41
42   .../...
43
44   [ Updated Translations ]
45   * Catalan (Jordi Mallach).
46   * Portuguese (Miguel Figueiredo).
47   * Swedish (Daniel Nylander).
48 ==========================================================
49
50   New translations should go in a dedicated section named
51   "[ New Translations ]":
52
53 ==========================================================
54 dpkg (1.13.15) unstable; urgency=low
55
56   .../...
57
58   [ New Translations ]
59   * Vogon (Douglas Adams).
60 ==========================================================
61
62   This file contents MUST be encoded in UTF-8, and the entries inserted
63   in language alphabetical order.
64
65 * Format of commit message
66
67   The formats above only apply to ChangeLog files and debian/changelog.
68   They do not apply to the commit message. Following recommendations
69   of http://wiki.debian.org/Teams/Dpkg/GitUsage you should start the
70   commit message with a summary line, followed by an empty line and a
71   a detailed/long description. For example:
72
73 ==========================================================
74 Updated german translation of manual pages
75
76         * man/po/fr.po: Updated to 1354t.
77 ==========================================================
78
79 * Use of po/LINGUAS, dselect/po/LINGUAS or scripts/po/LINGUAS:
80
81   When ADDING a new translation, don't forget adding the language to
82   the LINGUAS file, otherwise it will not be used.
83
84 * Always CHECK your translations:
85
86   You MUST check your PO files for validity.
87
88   The correct syntax for doing so is:
89
90   $ msgmerge -U <file> dpkg.pot
91   $ msgfmt -c -o /dev/null --statistics <file>
92   $ msgcat <file> >/dev/null
93
94   - msgmerge updates your file with the current POT file.
95   - msgfmt checks it for validity.
96   - msgcat may detect encoding problems.
97