From: Junio C Hamano <gitster@pobox.com>
To: Jiang Xin <worldhello.net@gmail.com>
Cc: Brian Gesiak <modocache@gmail.com>, Git List <git@vger.kernel.org>
Subject: Re: [PATCH 2/3] i18n: Only extract comments marked by special tag
Date: Fri, 18 Apr 2014 10:48:08 -0700 [thread overview]
Message-ID: <xmqqy4z2bkbr.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <xmqqha5qd1hl.fsf@gitster.dls.corp.google.com> (Junio C. Hamano's message of "Fri, 18 Apr 2014 09:52:06 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Documentation/CodingGuidelines may want to have a sentence of two to
> explain this, though.
After re-reading what I sent out, I realized that the way I singled
out multi-line comments was misleading. Here is an updated version.
-- >8 --
Subject: [PATCH] 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>
---
Documentation/CodingGuidelines | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index dab5c61..f9b8bff 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.
--
1.9.2-651-g78816bc
next prev parent reply other threads:[~2014-04-18 17:48 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-04-16 22:51 [l10n] date: Note for translators not included in .po files Brian Gesiak
2014-04-17 1:41 ` Jiang Xin
2014-04-17 5:37 ` [PATCH 0/3] extract proper comments for l10n translators Jiang Xin
2014-04-17 5:50 ` Jiang Xin
2014-04-17 18:12 ` Junio C Hamano
2014-04-17 5:37 ` [PATCH 1/3] i18n: Fixes uncatchable comments for translators Jiang Xin
2014-04-17 5:37 ` [PATCH 2/3] i18n: Only extract comments marked by special tag Jiang Xin
2014-04-17 18:08 ` Junio C Hamano
2014-04-18 6:03 ` Jiang Xin
2014-04-18 16:52 ` Junio C Hamano
2014-04-18 17:48 ` Junio C Hamano [this message]
2014-04-17 5:37 ` [PATCH 3/3] i18n: Remove obsolete comments for translators Jiang Xin
2014-04-17 6:27 ` [l10n] date: Note for translators not included in .po files Jiang Xin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqy4z2bkbr.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=modocache@gmail.com \
--cc=worldhello.net@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).