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.
This commit is contained in:
Karl Hallsby 2022-12-28 17:40:58 -06:00 committed by Ricardo Wurmus
parent d07d6ea31a
commit d0d700526c
No known key found for this signature in database
GPG Key ID: 197A5888235FACAC
1 changed files with 6 additions and 0 deletions

View File

@ -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