GNU bug report logs - #42351
[PATCH] doc: Warn against using the .scm extension for the channel news file.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 42351 in the body.
You can then email your comments to 42351 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: guix-patches <at> gnu.org
Subject: [PATCH] doc: Warn against using the .scm extension for the channel
 news file.
Date: Tue, 14 Jul 2020 10:48:52 +0200

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

Message #8 received at 42351 <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Pierre Neidhardt <mail <at> ambrevar.xyz>
Cc: 42351 <at> debbugs.gnu.org
Subject: Re: [bug#42351] [PATCH] doc: Warn against using the .scm extension
 for the channel news file.
Date: Tue, 21 Jul 2020 18:38:09 +0200

Hi,

Pierre Neidhardt <mail <at> 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’.

Message #11 received at 42351 <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 42351 <at> debbugs.gnu.org
Subject: Re: [bug#42351] [PATCH] doc: Warn against using the .scm extension
 for the channel news file.
Date: Tue, 21 Jul 2020 19:12:28 +0200

[Message part 1 (text/plain, inline)]

Should I merge?

-- 
Pierre Neidhardt
https://ambrevar.xyz/

[signature.asc (application/pgp-signature, inline)]

Message #14 received at 42351 <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Pierre Neidhardt <mail <at> ambrevar.xyz>
Cc: 42351 <at> debbugs.gnu.org
Subject: Re: [bug#42351] [PATCH] doc: Warn against using the .scm extension
 for the channel news file.
Date: Wed, 22 Jul 2020 12:06:12 +0200

Hi Pierre,

Pierre Neidhardt <mail <at> ambrevar.xyz> skribis:

> Should I merge?

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

Thanks,
Ludo’.

Message #17 received at 42351 <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 42351 <at> debbugs.gnu.org
Subject: Re: [bug#42351] [PATCH] doc: Warn against using the .scm extension
 for the channel news file.
Date: Tue, 28 Jul 2020 13:50:13 +0200

[Message part 1 (text/plain, inline)]

Done in 64e8f2ec2dc6301019a5b93a82787ea6adaf8c76.

-- 
Pierre Neidhardt
https://ambrevar.xyz/

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.