diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2014-04-18 10:48:08 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-04-18 10:48:49 -0700 |
| commit | cbcfd4e3ea9db3125619591b942f56d0a8f3ef48 (patch) | |
| tree | 3631574b59861bc0cf8403ae49d57683db3a17ec | |
| parent | i18n: only extract comments marked with "TRANSLATORS:" (diff) | |
| download | tgif-cbcfd4e3ea9db3125619591b942f56d0a8f3ef48.tar.xz | |
i18n: mention "TRANSLATORS:" marker in Documentation/CodingGuidelines
These comments have to have "TRANSLATORS: " at the very beginning
and have to deviate from the usual multi-line comment formatting
convention.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/CodingGuidelines | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index dab5c61bfe..f424dbd75c 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -164,6 +164,16 @@ For C programs: * multi-line comment. */ + Note however that a comment that explains a translatable string to + translators uses a convention of starting with a magic token + "TRANSLATORS: " immediately after the opening delimiter, even when + it spans multiple lines. We do not add an asterisk at the beginning + of each line, either. E.g. + + /* TRANSLATORS: here is a comment that explains the string + to be translated, that follows immediately after it */ + _("Here is a translatable string explained by the above."); + - Double negation is often harder to understand than no negation at all. |