diff options
author | Daiki Ueno <ueno@gnu.org> | 2014-12-01 16:45:57 +0900 |
---|---|---|
committer | Daiki Ueno <ueno@gnu.org> | 2014-12-01 16:46:18 +0900 |
commit | 9c69b12922e17adae7abc846bb5006fa5828f4ec (patch) | |
tree | 7912d785e456cf070ee8834ca63b9221e28f8d03 | |
parent | f71fc3490caab799312a5fe67a80e56d5d8c9d6d (diff) | |
download | external_gettext-9c69b12922e17adae7abc846bb5006fa5828f4ec.zip external_gettext-9c69b12922e17adae7abc846bb5006fa5828f4ec.tar.gz external_gettext-9c69b12922e17adae7abc846bb5006fa5828f4ec.tar.bz2 |
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:
<https://savannah.gnu.org/bugs/index.php?42376>.
-rw-r--r-- | gettext-tools/doc/ChangeLog | 8 | ||||
-rw-r--r-- | gettext-tools/doc/xgettext.texi | 19 |
2 files changed, 27 insertions, 0 deletions
diff --git a/gettext-tools/doc/ChangeLog b/gettext-tools/doc/ChangeLog index e96e8bf..4bd9936 100644 --- a/gettext-tools/doc/ChangeLog +++ b/gettext-tools/doc/ChangeLog @@ -1,3 +1,11 @@ +2014-12-01 Daiki Ueno <ueno@gnu.org> + + 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: + <https://savannah.gnu.org/bugs/index.php?42376>. + 2014-10-15 Daiki Ueno <ueno@gnu.org> * gettext 0.19.3 released. diff --git a/gettext-tools/doc/xgettext.texi b/gettext-tools/doc/xgettext.texi index d187d63..451e25f 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 |