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>
This commit is contained in:
Karl Hallsby 2022-12-28 17:40:59 -06:00 committed by Ricardo Wurmus
parent d0d700526c
commit de781de2e9
No known key found for this signature in database
GPG key ID: 197A5888235FACAC

View file

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