README.l10n

   1 Translators, when adding/updating your translation files, please follow
   2 the following rules:
   3
   4 * Do not update debian/changelog:
   5
   6   - The file will get generated out of the commit messages at release time.
   7   - Beware that you should NOT update any of the legacy ChangeLog.old
   8     files for translation updates.
   9
  10 * Format of commit message
  11
  12   Following guidelines in <https://wiki.debian.org/Teams/Dpkg/GitUsage>
  13   you should start the commit message with a summary line, followed by an
  14   empty line and optional pseudo-headers.
  15
  16   The summary line should use the following format:
  17
  18   «po: <Action> <Language> [<part> ]translation»
  19
  20   Where:
  21
  22   - <Action> is one of “Update” or “Add”,
  23   - <Language> should be capitalized (such as “English”),
  24   - <part> should be one of «programs» (for lib/, src/ and utils/), «dselect»,
  25     «scripts» and «man pages» (man/), or not be set if the commit includes
  26     changes to various parts.
  27
  28   For example:
  29
  30 ==========================================================
  31 po: Update German programs translation
  32
  33 Closes: #123456
  34 Reviewed-by: Full Name <email@example.org>
  35 ==========================================================
  36
  37 * Use of po/LINGUAS, dselect/po/LINGUAS or scripts/po/LINGUAS:
  38
  39   When ADDING a new translation, don't forget adding the language to
  40   the LINGUAS file, otherwise it will not be used.
  41
  42 * Always CHECK your translations:
  43
  44   You MUST check your PO files for validity.
  45
  46   The correct syntax for doing so is:
  47
  48   $ msgmerge --update <file> dpkg.pot
  49   $ msgfmt --check --output-file /dev/null --statistics <file>
  50   $ msgcat <file> >/dev/null
  51
  52   - msgmerge updates your file with the current POT file.
  53   - msgfmt checks it for validity.
  54   - msgcat may detect encoding problems.
  55
  56   In addition to the above, the easiest way to check that the po4a
  57   translations have valid POD markup, is to try to build them (please
  58   see the Building sections in the README file for further details
  59   regarding the setup of the source tree):
  60
  61   $ make -C man