[bug#68419] [PATCH] Clarify definition of channel files in the cookbook.

[bug#68419] [PATCH] Clarify definition of channel files in the cookbook.

[Daniel Khodabakhsh]

[-- Attachment #1: Type: text/plain, Size: 1313 bytes --]

From 8bad2696e628f9415a4e720b60df095d65686ba9 Mon Sep 17 00:00:00 2001
From: Daniel Khodabakhsh <d.khodabakhsh@gmail.com>
Date: Fri, 12 Jan 2024 12:49:27 -0800
Subject: [PATCH] Clarify definition of channel files in the cookbook.

---
 doc/guix-cookbook.texi | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi
index 2366c13..21fec10 100644
--- a/doc/guix-cookbook.texi
+++ b/doc/guix-cookbook.texi
@@ -805,7 +805,7 @@ mkdir ~/my-channel
 @end example

 Suppose you want to add the @samp{my-hello} package we saw previously;
-it first needs some adjustments:
+@file{my-hello.scm} first needs some adjustments:

 @lisp
 (define-module (my-hello)
@@ -835,6 +835,10 @@ command-line arguments, multiple languages, and so on.")
     (license gpl3+)))
 @end lisp

+Instead of starting with a @code{user-module} expression, a
@code{define-module}
+expression is used. This expression defines the name of the module
and must match
+the file name used (@samp{my-hello} from @file{my-hello.scm}).
+
 Note that we have assigned the package value to an exported variable name with
 @code{define-public}.  This is effectively assigning the package to
the @code{my-hello}
 variable so that it can be referenced, among other as dependency of other
-- 
2.30.2

[-- Attachment #2: 0001-Clarify-definition-of-channel-files-in-the-cookbook.patch --]
[-- Type: application/octet-stream, Size: 1317 bytes --]

From 8bad2696e628f9415a4e720b60df095d65686ba9 Mon Sep 17 00:00:00 2001
From: Daniel Khodabakhsh <d.khodabakhsh@gmail.com>
Date: Fri, 12 Jan 2024 12:49:27 -0800
Subject: [PATCH] Clarify definition of channel files in the cookbook.

---
 doc/guix-cookbook.texi | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi
index 2366c13..21fec10 100644
--- a/doc/guix-cookbook.texi
+++ b/doc/guix-cookbook.texi
@@ -805,7 +805,7 @@ mkdir ~/my-channel
 @end example
 
 Suppose you want to add the @samp{my-hello} package we saw previously;
-it first needs some adjustments:
+@file{my-hello.scm} first needs some adjustments:
 
 @lisp
 (define-module (my-hello)
@@ -835,6 +835,10 @@ command-line arguments, multiple languages, and so on.")
     (license gpl3+)))
 @end lisp
 
+Instead of starting with a @code{user-module} expression, a @code{define-module}
+expression is used. This expression defines the name of the module and must match
+the file name used (@samp{my-hello} from @file{my-hello.scm}).
+
 Note that we have assigned the package value to an exported variable name with
 @code{define-public}.  This is effectively assigning the package to the @code{my-hello}
 variable so that it can be referenced, among other as dependency of other
-- 
2.30.2

[bug#68419] [PATCH] Clarify definition of channel files in the cookbook.

[Daniel Khodabakhsh]

[-- Attachment #1: Type: text/plain, Size: 123 bytes --]

Sorry this is my first patch email. Looks like gmail added a few
newlines. The attached patch file is correctly formatted.

[-- Attachment #2: 0001-Clarify-definition-of-channel-files-in-the-cookbook.patch --]
[-- Type: application/x-patch, Size: 1317 bytes --]