* [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file.
@ 2020-07-14 8:48 Pierre Neidhardt
2020-07-21 16:38 ` Ludovic Courtès
0 siblings, 1 reply; 5+ messages in thread
From: Pierre Neidhardt @ 2020-07-14 8:48 UTC (permalink / raw)
To: 42351
* 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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file.
2020-07-14 8:48 [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file Pierre Neidhardt
@ 2020-07-21 16:38 ` Ludovic Courtès
2020-07-21 17:12 ` Pierre Neidhardt
0 siblings, 1 reply; 5+ messages in thread
From: Ludovic Courtès @ 2020-07-21 16:38 UTC (permalink / raw)
To: Pierre Neidhardt; +Cc: 42351
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’.
^ permalink raw reply [flat|nested] 5+ messages in thread
* [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file.
2020-07-21 16:38 ` Ludovic Courtès
@ 2020-07-21 17:12 ` Pierre Neidhardt
2020-07-22 10:06 ` Ludovic Courtès
0 siblings, 1 reply; 5+ messages in thread
From: Pierre Neidhardt @ 2020-07-21 17:12 UTC (permalink / raw)
To: Ludovic Courtès; +Cc: 42351
[-- Attachment #1: Type: text/plain, Size: 65 bytes --]
Should I merge?
--
Pierre Neidhardt
https://ambrevar.xyz/
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file.
2020-07-21 17:12 ` Pierre Neidhardt
@ 2020-07-22 10:06 ` Ludovic Courtès
2020-07-28 11:50 ` Pierre Neidhardt
0 siblings, 1 reply; 5+ messages in thread
From: Ludovic Courtès @ 2020-07-22 10:06 UTC (permalink / raw)
To: Pierre Neidhardt; +Cc: 42351
Hi Pierre,
Pierre Neidhardt <mail@ambrevar.xyz> skribis:
> Should I merge?
Yes, that’s what I meant by “LGTM”. :-)
Thanks,
Ludo’.
^ permalink raw reply [flat|nested] 5+ messages in thread
* [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file.
2020-07-22 10:06 ` Ludovic Courtès
@ 2020-07-28 11:50 ` Pierre Neidhardt
0 siblings, 0 replies; 5+ messages in thread
From: Pierre Neidhardt @ 2020-07-28 11:50 UTC (permalink / raw)
To: Ludovic Courtès; +Cc: 42351
[-- Attachment #1: Type: text/plain, Size: 99 bytes --]
Done in 64e8f2ec2dc6301019a5b93a82787ea6adaf8c76.
--
Pierre Neidhardt
https://ambrevar.xyz/
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-07-28 11:51 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-07-14 8:48 [bug#42351] [PATCH] doc: Warn against using the .scm extension for the channel news file Pierre Neidhardt
2020-07-21 16:38 ` 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
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.