summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorJan Nieuwenhuizen <janneke@gnu.org>2019-07-13 16:31:50 +0200
committerJan Nieuwenhuizen <janneke@gnu.org>2019-07-14 00:58:09 +0200
commit53f21642729e4786141c072dd835b04cb85dfe28 (patch)
treec95faf15aa682961c9e51abeaf41b45d17ba8e48 /doc
parentbee9f97e0ae55c1d4c7e35ddd1c31be24ff32e23 (diff)
downloadguix-53f21642729e4786141c072dd835b04cb85dfe28.tar.gz
channels: Add optional directory to channel metadata.
* guix/channels.scm (<channel-metadata>): Add directory slot.  Update users.
(read-channel-metadata-from-source): New function.
(standard-module-derivation): Use it.
* doc/guix.texi (Package Modules in a Subdirectory): New subsection.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 5a8ad7ebda..458fca20af 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -3921,6 +3921,19 @@ For the sake of reliability and maintainability, you should avoid dependencies
 on channels that you don't control, and you should aim to keep the number of
 dependencies to a minimum.
 
+@cindex subdirectory, channels
+@subsection Package Modules in a Sub-directory
+
+As a channel author, you may want to keep your channel modules in a
+sub-directory.  If your modules are in the sub-directory @file{guix}, you must
+add a meta-data file @file{.guix-channel} that contains:
+
+@lisp
+(channel
+  (version 0)
+  (directory "guix"))
+@end lisp
+
 @subsection Replicating Guix
 
 @cindex pinning, channels