From d0d700526c362272d11b0c3be8ba7861a21e1e42 Mon Sep 17 00:00:00 2001
From: Karl Hallsby <karl@hallsby.com>
Date: Wed, 28 Dec 2022 17:40:58 -0600
Subject: 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.
---
 doc/guix.texi | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'doc')

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
 
-- 
cgit 1.4.1