branch master updated: doc: Warn against using the .scm extension for the channel news file.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

ambrevar pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new 64e8f2e  doc: Warn against using the .scm extension for the channel 
news file.
64e8f2e is described below

commit 64e8f2ec2dc6301019a5b93a82787ea6adaf8c76
Author: Pierre Neidhardt <mail@ambrevar.xyz>
AuthorDate: Tue Jul 14 10:46:44 2020 +0200

    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.
---
 doc/guix.texi | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index d4557b3..74c7417 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