diff options
author | Karl Hallsby <karl@hallsby.com> | 2022-12-28 17:40:58 -0600 |
---|---|---|
committer | Ricardo Wurmus <rekado@elephly.net> | 2022-12-29 20:01:59 +0100 |
commit | d0d700526c362272d11b0c3be8ba7861a21e1e42 (patch) | |
tree | b6047545a40595963673d2a7476fd7e955d21ff6 /doc | |
parent | d07d6ea31a883d395d692483d84e7797b4c2ce0f (diff) | |
download | guix-d0d700526c362272d11b0c3be8ba7861a21e1e42.tar.gz |
doc: Describe format of channel that uses directory field.
* doc/guix.texi (Package Modules in a Sub-directory): Explain that directory must be the module root.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 6 |
1 files changed, 6 insertions, 0 deletions
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 |