diff mbox series

[bug#42351] doc: Warn against using the .scm extension for the channel news file.

Message ID 20200714084852.30401-1-mail@ambrevar.xyz
State Accepted
Headers show
Series [bug#42351] doc: Warn against using the .scm extension for the channel news file. | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch success View Laminar job

Commit Message

Pierre Neidhardt July 14, 2020, 8:48 a.m. UTC 
* 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(-)

Comments

Ludovic Courtès July 21, 2020, 4:38 p.m. UTC | #1 
Hi,

Pierre Neidhardt <mail@ambrevar.xyz> skribis:

> * 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.

LGTM, thanks!

Ludo’.
Pierre Neidhardt July 21, 2020, 5:12 p.m. UTC | #2 
Should I merge?
Ludovic Courtès July 22, 2020, 10:06 a.m. UTC | #3 
Hi Pierre,

Pierre Neidhardt <mail@ambrevar.xyz> skribis:

> Should I merge?

Yes, that’s what I meant by “LGTM”.  :-)

Thanks,
Ludo’.
Pierre Neidhardt July 28, 2020, 11:50 a.m. UTC | #4 
Done in 64e8f2ec2dc6301019a5b93a82787ea6adaf8c76.
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 17338ed764..0694ec07ca 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4340,6 +4340,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
@@ -4358,7 +4364,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