[PATCH 0/2] [DOCUMENTATION]: describe .guix-channel directory field

  • Done
  • quality assurance status badge
Details
2 participants
  • Karl Hallsby
  • Ricardo Wurmus
Owner
unassigned
Submitted by
Karl Hallsby
Severity
normal
K
K
Karl Hallsby wrote on 29 Dec 2022 00:39
(name . Karl Hallsby)(address . karl@hallsby.com)
cover.1672270580.git.karl@hallsby.com
This patch series includes additional information about why one would want to
use the directory field of the .guix-channel file for a channel, and some
nuances that come from it.

Karl Hallsby (2):
doc: describe format of channel that uses directory field
doc: give example of when to use describe in .guix-channel file

doc/guix.texi | 11 +++++++++++
1 file changed, 11 insertions(+)


base-commit: 4ca649e978f08335fcabdcef693a7049082b5373
--
2.37.1
K
K
Karl Hallsby wrote on 29 Dec 2022 00:40
[PATCH 1/2] doc: describe format of channel that uses directory field
(name . Karl Hallsby)(address . karl@hallsby.com)
54c65d6fecf7acd0a82629945607f7956e182d6d.1672270580.git.karl@hallsby.com
---
doc/guix.texi | 6 ++++++
1 file changed, 6 insertions(+)

Toggle diff (19 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index 053cd1ad41..7c02e2d392 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5614,6 +5614,12 @@ add a meta-data file @file{.guix-channel} that contains:
(directory "guix"))
@end lisp
+The modules must be @b{underneath} the specified directory, as the
+@code{directory} changes Guile's @code{load-path}. For example, if
+@file{.guix-channel} has @code{(directory "base")}, then a module
+defined as @code{(define-module (gnu packages fun))} must be located at
+@code{base/gnu/packages/fun.scm}.
+
@node Declaring Channel Dependencies
@section Declaring Channel Dependencies
--
2.37.1
K
K
Karl Hallsby wrote on 29 Dec 2022 00:40
[PATCH 2/2] doc: give example of when to use describe in .guix-channel file
(name . Karl Hallsby)(address . karl@hallsby.com)
2179575812ab418c3a98f102d2d4448b64c20b87.1672270580.git.karl@hallsby.com
---
doc/guix.texi | 5 +++++
1 file changed, 5 insertions(+)

Toggle diff (18 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index 7c02e2d392..cb9d1d685c 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5620,6 +5620,11 @@ The modules must be @b{underneath} the specified directory, as the
defined as @code{(define-module (gnu packages fun))} must be located at
@code{base/gnu/packages/fun.scm}.
+Doing this allows for only parts of a repository to be used as a
+channel, as Guix looks for valid Guile modules when pulling. For
+instance, by default @command{guix deploy} machine configuration files
+are not valid Guile modules, making @command{guix pull} fail.
+
@node Declaring Channel Dependencies
@section Declaring Channel Dependencies
--
2.37.1
R
R
Ricardo Wurmus wrote on 29 Dec 2022 20:02
[PATCH 0/2] [DOCUMENTATION]: describe .guix-channel directory field
(address . 60392-done@debbugs.gnu.org)
87edsi9gnm.fsf@elephly.net
Thank you for the patches! I reworded the commit message and changed
the text of the example slightly before pushing.

Thanks!

--
Ricardo
Closed
?