From 9c69b12922e17adae7abc846bb5006fa5828f4ec Mon Sep 17 00:00:00 2001 From: Daiki Ueno Date: Mon, 1 Dec 2014 16:45:57 +0900 Subject: [PATCH] doc: Document placement of extracted comment blocks * xgettext.texi: Mention that extracted comment blocks must be adjacent to keyword lines. Reported by Yves-Gwenael Bourhis at: . --- gettext-tools/doc/ChangeLog | 8 ++++++++ gettext-tools/doc/xgettext.texi | 19 +++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/gettext-tools/doc/ChangeLog b/gettext-tools/doc/ChangeLog index e96e8bf2a..4bd99366c 100644 --- a/gettext-tools/doc/ChangeLog +++ b/gettext-tools/doc/ChangeLog @@ -1,3 +1,11 @@ +2014-12-01 Daiki Ueno + + doc: Document placement of extracted comment blocks + * xgettext.texi: Mention that extracted comment blocks must be + adjacent to keyword lines. + Reported by Yves-Gwenael Bourhis at: + . + 2014-10-15 Daiki Ueno * gettext 0.19.3 released. diff --git a/gettext-tools/doc/xgettext.texi b/gettext-tools/doc/xgettext.texi index d187d6343..451e25fb6 100644 --- a/gettext-tools/doc/xgettext.texi +++ b/gettext-tools/doc/xgettext.texi @@ -125,6 +125,25 @@ Place comment blocks starting with @var{tag} and preceding keyword lines in the output file. Without a @var{tag}, the option means to put @emph{all} comment blocks preceding keyword lines in the output file. +Note that comment blocks supposed to be extracted must be adjacent to +keyword lines. For example, in the following C source code: + +@example +/* This is the first comment. */ +gettext ("foo"); + +/* This is the second comment: not extracted */ +gettext ( + "bar"); + +gettext ( + /* This is the third comment. */ + "baz"); +@end example + +The second comment line will not be extracted, because there is one +blank line between the comment line and the keyword. + @end table @subsection Language specific options -- 2.47.3