diff options
author | Karl Hallsby <karl@hallsby.com> | 2022-12-28 17:40:59 -0600 |
---|---|---|
committer | Ricardo Wurmus <rekado@elephly.net> | 2022-12-29 20:01:59 +0100 |
commit | de781de2e9cb10feeef8dfa5caf26bcc0e6ac745 (patch) | |
tree | 8c2e9d461b0cc1b8bcb26ecdc06cf472c201e495 | |
parent | d0d700526c362272d11b0c3be8ba7861a21e1e42 (diff) | |
download | guix-de781de2e9cb10feeef8dfa5caf26bcc0e6ac745.tar.gz |
doc: Give example of when to use describe in .guix-channel file.
* doc/guix.texi (Package Modules in a Sub-directory): Mention "guix deploy" files as an example. Signed-off-by: Ricardo Wurmus <rekado@elephly.net>
-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 7c02e2d392..3ed71424fa 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -5620,6 +5620,12 @@ The modules must be @b{underneath} the specified directory, as the defined as @code{(define-module (gnu packages fun))} must be located at @code{base/gnu/packages/fun.scm}. +Doing this allows for only parts of a repository to be used as a +channel, as Guix expects valid Guile modules when pulling. For +instance, @command{guix deploy} machine configuration files are not +valid Guile modules, and treating them as such would make @command{guix +pull} fail. + @node Declaring Channel Dependencies @section Declaring Channel Dependencies |