summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-06-04 00:55:44 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-06-04 00:55:44 (GMT)
commitc5da34c12481ff6edc3f46463cbf43efe856308e (patch)
tree1f6be27746458c6314427a3ba264db6341288151 /Documentation/CodingGuidelines
parentfe3bf4cb526aa85941c30b6e9104e8b0a84094c3 (diff)
parent66f5f6dca95eda46bf02c8d06de8cb265995fd6e (diff)
downloadgit-c5da34c12481ff6edc3f46463cbf43efe856308e.zip
git-c5da34c12481ff6edc3f46463cbf43efe856308e.tar.gz
git-c5da34c12481ff6edc3f46463cbf43efe856308e.tar.bz2
Merge branch 'ab/c-translators-comment-style'
Update the C style recommendation for notes for translators, as recent versions of gettext tools can work with our style of multi-line comments. * ab/c-translators-comment-style: C style: use standard style for "TRANSLATORS" comments
Diffstat (limited to 'Documentation/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines10
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 2248cf7..c4cb5ff 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -256,12 +256,12 @@ For C programs:
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: ", e.g.
- /* TRANSLATORS: here is a comment that explains the string
- to be translated, that follows immediately after it */
+ /*
+ * 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