nixo
/
guix-devel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Clarify the module file name convention. 

* doc/guix.texi (Package Modules): Clarify the footnote about the module file
  names convention.  Tweak the wording.
This commit is contained in:
Ludovic Courtès 2015-05-22 16:20:04 +02:00
parent 748cef5be9
commit c95ded7ed6
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/guix.texi
View File

@ -6154,11 +6154,15 @@ facility is implemented in the @code{(gnu packages)} module.
@cindex package module search path @cindex package module search path
Users can store package definitions in modules with different Users can store package definitions in modules with different
names---e.g., @code{(my-packages emacs)}@footnote{Note that the file names---e.g., @code{(my-packages emacs)}@footnote{Note that the file
name and module name must match. @xref{Modules and the File System,,, name and module name must match. For instance, the @code{(my-packages
guile, GNU Guile Reference Manual}, for details.} These package definitions 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 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 @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 @code{-L} option of these commands to make those modules visible
(@pxref{Invoking guix build, @code{--load-path}}), or define the (@pxref{Invoking guix build, @code{--load-path}}), or define the
@code{GUIX_PACKAGE_PATH} environment variable. This environment @code{GUIX_PACKAGE_PATH} environment variable. This environment