summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2014-04-21 10:42:52 -0700
committerJunio C Hamano <gitster@pobox.com>2014-04-21 10:42:52 -0700
commit8fe3ee67adcd2ee9372c7044fa311ce55eb285b4 (patch)
treede9808909692a95575e34d29cf0eb5b832b5c851 /Documentation
parent0b17b4331087224883878e49342037bf69717b62 (diff)
parentcbcfd4e3ea9db3125619591b942f56d0a8f3ef48 (diff)
downloadgit-8fe3ee67adcd2ee9372c7044fa311ce55eb285b4.tar.gz
Merge branch 'jx/i18n'
* jx/i18n: i18n: mention "TRANSLATORS:" marker in Documentation/CodingGuidelines i18n: only extract comments marked with "TRANSLATORS:" i18n: remove obsolete comments for translators in diffstat generation i18n: fix uncatchable comments for translators in date.c
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingGuidelines10
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.