summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Neidhardt <mail@ambrevar.xyz>2020-07-14 10:46:44 +0200
committerPierre Neidhardt <mail@ambrevar.xyz>2020-07-28 13:43:45 +0200
commit64e8f2ec2dc6301019a5b93a82787ea6adaf8c76 (patch)
treea79ea4850697e1add1f91ab8ffa1f6ccf5569cab
parentf2dc025edab09b2f1c6cdce521635d0f518134ee (diff)
doc: Warn against using the .scm extension for the channel news file.
* doc/guix.texi (Writing Channel News): Explain the issue with using the .scm extension and possible workarounds; fix the example to use the .txt extension instead.
-rw-r--r--doc/guix.texi8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index d4557b360a..74c7417174 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4358,6 +4358,12 @@ something like this:
(body (en "Don't miss the @@code@{hello@} package!"))))
@end lisp
+While the news file is using the Scheme syntax, avoid naming it with a
+@file{.scm} extension or else it will get picked up when building the
+channel and yield an error since it is not a valid module.
+Alternatively, you can move the channel module to a subdirectory and
+store the news file in another directory.
+
The file consists of a list of @dfn{news entries}. Each entry is
associated with a commit or tag: it describes changes made in this
commit, possibly in preceding commits as well. Users see entries only
@@ -4376,7 +4382,7 @@ you write news entries in English first, the command below creates a PO
file containing the strings to translate:
@example
-xgettext -o news.po -l scheme -ken etc/news.scm
+xgettext -o news.po -l scheme -ken etc/news.txt
@end example
To sum up, yes, you could use your channel as a blog. But beware, this