diff mbox series

[bug#60392,1/2] doc: describe format of channel that uses directory field

Message ID 54c65d6fecf7acd0a82629945607f7956e182d6d.1672270580.git.karl@hallsby.com
State New
Headers show
Series : describe .guix-channel directory field | expand

Commit Message

Karl Hallsby Dec. 28, 2022, 11:40 p.m. UTC 
---
 doc/guix.texi | 6 ++++++
 1 file changed, 6 insertions(+)
diff mbox series

Patch

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