summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2017-10-03 14:48:09 +0200
committerLudovic Courtès <ludo@gnu.org>2017-10-03 17:07:54 +0200
commite797e94bf5298ed03a6677055d87bb6a9662d0d1 (patch)
tree90ae8ffef5407f9a0bbd8a6dc5308cefd5bbc8a5 /doc
parentdf71c88c3a3600cc8e58c3343e48e46ccccc531e (diff)
doc: Explain why synopses/descriptions must be literal strings.
Suggested by Dave Love <fx@gnu.org>. * doc/guix.texi (Synopses and Descriptions): Recommend literal strings.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index c57c0bab63..9e301d0072 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -19147,6 +19147,18 @@ Translation Project} so that as many users as possible can read them in
their native language. User interfaces search them and display them in
the language specified by the current locale.
+To allow @command{xgettext} to extract them as translatable strings,
+synopses and descriptions @emph{must be literal strings}. This means
+that you cannot use @code{string-append} or @code{format} to construct
+these strings:
+
+@lisp
+(package
+ ;; @dots{}
+ (synopsis "This is translatable")
+ (description (string-append "This is " "*not*" " translatable.")))
+@end lisp
+
Translation is a lot of work so, as a packager, please pay even more
attention to your synopses and descriptions as every change may entail
additional work for translators. In order to help them, it is possible