chiark / gitweb /
git-debrebase: Provide convert-from-unapplied aa alias for -gbp
[dgit.git] / po / README
1 NOTES FOR TRANSLATORS
2 =====================
3
4 Introduction
5 ------------
6
7 The dgit source package contains dgit and git-debrebase.
8 These are useful for a variety of different users and in different
9 situations.  So there are various documents aimed at various users.
10
11 * dgit and git-debrebase both support message translation.
12
13 * Documentation translation is handled via po4a, in the po4a
14   directory.  The documeents are all manpages.
15
16 * git-debrebase is currently mostly useful within the Debian project,
17   but this will change and its document translations will then be more
18   important.
19
20 The en_US message translation is slightly special.  It is used for
21 testing the translation machinery, and since the source native
22 language is en_GB, there is not much other need for the en_US
23 translation.
24
25 The threshold for generation of a translated documents has been set to
26 10% (of each individual document).  The documents are quite sectional
27 and I expect even a partially translated document to be useful.
28
29
30 Translatation priorities
31 ------------------------
32
33   HIGH
34
35     po4a/dgit-user_1.pot    How to use dgit to as a downstream or user
36
37   MEDIUM
38
39     po/messages.pot         All the messages for both programs
40
41     po4a/dgit_1
42     po4a/dgit-downstream-dsc_7
43     po4a/dgit-sponshorship_7
44     po4a/dgit_7
45
46   LOW
47
48     po4a/dgit-maint-*       } For work within the Debian project
49     po4a/dgit-nmu-simple_7  }  (where one needs good English anyway)
50
51     po4a/git-debrebase_*    Currently low priority but this will change
52
53
54 Translation organisation
55 ------------------------
56
57   po/messages.pot      all messages from both dgit and git-debrebase
58   po/LANG.po           translations of those
59   po/mo                output directory, do not look here
60
61   po4a/MAN_S.pot       paragraphs from manpage MAN in section S
62   po4a/MAN_S.LANG.po   translation of manpage MAN(S) into LANG
63   po4a/po4a.cfg        config file for po4a
64   po4a/LANG.preview    preview for you, see below
65   po4a/translated/     output directory, do not look here
66
67
68 Note on git-debrebase
69 ---------------------
70
71 git-debrebase has a fairly complex underlying model, which is defined
72 in git-debrebase(5).
73
74 It is importnt when translating both documents and messages for
75 git-derebase, that consistent translations are used for the words
76 defined in `TERMINOLOGY' and `BRANCH CONTENTS'.
77
78 You may want to start by reading git-debrebase(5).
79
80 When translating git-debrebaase(5) itself, please add the English term
81 after the definining use of each word.  For example
82    Your-word-for-pseudomerge (Pseudomerge)
83        translation of the definition
84 This will be useful because some of these words appear in
85 necessarily-untranslated but user-visible protocol elements
86 (eg sometimes in annotations in autogenerated git commit messages)
87
88
89 To start translating
90 --------------------
91
92 In po/
93
94   1. run
95       make LANGUAGE.po
96   2. edit LANGUAGE.po to add translations.
97
98 In po4a/
99
100   1. edit po4a.cfg to add your language to [po4a_langs]
101   2. then run
102      po4a po4a.cfg
103   3. edit each MANPAGE_SECTION.LANG.po to add translations.
104
105
106 Important commands for translators
107 ----------------------------------
108
109 In po/
110
111   make LANGUAGE.po     Creates or updates messages.pot and LANGUAGE.po.
112
113   make pofiles         Updates messages.pot from all the sources,
114                        with new messages, and merges them into
115                        all the language-specific .po files
116
117   make check           Updates everything and then checks everything,
118                        printing translation statistics.
119
120 In po4a/
121
122   po4a po4a.cfg        Updates all pot and po files
123
124   make preview.LANG    Makes a directory preview.LANG containing
125                        translated and compiled manpages which can
126                        be previewed with `man -l', and prints a
127                        list of appropriate `man -l' commands.
128                        (Requires `tcl' to be installed.)
129
130
131 Committing and contributing your translation
132 --------------------------------------------
133
134 When you're done you'll need to commit the changes you have made to
135 your language's po files.  If you started a new translation, don't
136 forget to `git add' your new files !
137
138 The easiest way to contribute your translation is probably for you to
139 file a Merge Request on Sala:
140   https://salsa.debian.org/dgit-team/dgit
141
142 Contributions via the Debian Bug Tracking System are also 
143 welcome.