me/guix
Archived
1
0
Fork 0
Code Activity

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

Browse source 
* 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.
This commit is contained in:
Pierre Neidhardt 2020-07-14 10:46:44 +02:00
parent f2dc025eda
commit 64e8f2ec2d
No known key found for this signature in database
GPG key ID: 9BDCF497A4BBCC7F
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/guix.texi
View file

@ -4358,6 +4358,12 @@ something like this:
(body (en "Don't miss the @@code@{hello@} package!")))) (body (en "Don't miss the @@code@{hello@} package!"))))
@end lisp @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 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 associated with a commit or tag: it describes changes made in this
commit, possibly in preceding commits as well. Users see entries only 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: file containing the strings to translate:
@example @example
xgettext -o news.po -l scheme -ken etc/news.scm xgettext -o news.po -l scheme -ken etc/news.txt
@end example @end example
To sum up, yes, you could use your channel as a blog. But beware, this To sum up, yes, you could use your channel as a blog. But beware, this