diff options
author | Ludovic Courtès <ludo@gnu.org> | 2015-05-22 16:20:04 +0200 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2015-05-22 16:22:00 +0200 |
commit | c95ded7ed6938aa5aaa9abce81d87b2d6dbc7aa7 (patch) | |
tree | 6941b92b1d132112287d71ff426a300dc1ba5983 /doc | |
parent | 748cef5be9c69978b5c70575340702d8df73f84a (diff) |
doc: Clarify the module file name convention.
* doc/guix.texi (Package Modules): Clarify the footnote about the module file
names convention. Tweak the wording.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 53761df351..9bd9c581ce 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -6154,11 +6154,15 @@ facility is implemented in the @code{(gnu packages)} module. @cindex package module search path Users can store package definitions in modules with different names---e.g., @code{(my-packages emacs)}@footnote{Note that the file -name and module name must match. @xref{Modules and the File System,,, -guile, GNU Guile Reference Manual}, for details.} These package definitions +name and module name must match. For instance, the @code{(my-packages +emacs)} module must be stored in a @file{my-packages/emacs.scm} file +relative to the load path specified with @option{--load-path} or +@code{GUIX_PACKAGE_PATH}. @xref{Modules and the File System,,, +guile, GNU Guile Reference Manual}, for details.}. These package definitions will not be visible by default. Thus, users can invoke commands such as @command{guix package} and @command{guix build} have to be used with the -@code{-e} option so that they know where to find the package, or use the +@code{-e} option so that they know where to find the package. Better +yet, they can use the @code{-L} option of these commands to make those modules visible (@pxref{Invoking guix build, @code{--load-path}}), or define the @code{GUIX_PACKAGE_PATH} environment variable. This environment |