02/02: doc: Give example of when to use describe in .guix-channel file.

[guix-commits]

rekado pushed a commit to branch master
in repository guix.

commit de781de2e9cb10feeef8dfa5caf26bcc0e6ac745
Author: Karl Hallsby <karl@hallsby.com>
AuthorDate: Wed Dec 28 17:40:59 2022 -0600

    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>
---
 doc/guix.texi | 6 ++++++
 1 file changed, 6 insertions(+)

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