From: Pierre Neidhardt <mail@ambrevar.xyz>
To: 42351@debbugs.gnu.org
Subject: [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file.
Date: Tue, 14 Jul 2020 10:48:52 +0200 [thread overview]
Message-ID: <20200714084852.30401-1-mail@ambrevar.xyz> (raw)
* 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
next reply other threads:[~2020-07-14 8:50 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-14 8:48 Pierre Neidhardt [this message]
2020-07-21 16:38 ` [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file Ludovic Courtès
2020-07-21 17:12 ` Pierre Neidhardt
2020-07-22 10:06 ` Ludovic Courtès
2020-07-28 11:50 ` Pierre Neidhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200714084852.30401-1-mail@ambrevar.xyz \
--to=mail@ambrevar.xyz \
--cc=42351@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).