summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2026-03-19 13:05:57 +0100
committerLudovic Courtès <ludo@gnu.org>2026-03-25 23:51:25 +0100
commit696d12ab8136bfc5bfb8dc6bd84648e43a859ce6 (patch)
tree83a5bdce8c804b860cb0cded0cb9826e0093fe7a /doc
parent8476c5bd8e4ed06dc287a5292354e29c14b7adf8 (diff)
doc: Add ‘with-imported-modules’ caveat.
* doc/guix.texi (G-Expressions): Document caveat under ‘with-imported-modules’. Change-Id: I9ee5452c7d776647961b282a0e6cefece165b00b Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index f4279bfb794..fa05c370773 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -12614,6 +12614,30 @@ path, and the last one is created from the given file-like object.
This form has @emph{lexical} scope: it has an effect on the gexps
directly defined in @var{body}@dots{}, but not on those defined, say, in
procedures called from @var{body}@dots{}.
+
+@quotation Caveat
+It is important to distinguish between modules available in the build
+environment and modules in scope. The @code{with-imported-modules} form
+pulls modules in the build environment of the gexp but it does
+@emph{not} import them. To do so, you still need to use
+@code{use-modules} in the gexp:
+
+@lisp
+(with-imported-modules '((guix build utils))
+ #~(begin
+ (use-modules (guix build utils))
+ @dots{}))
+@end lisp
+
+@xref{Using Guile Modules,,, guile, GNU Guile Reference Manual}, for
+more information on @code{use-modules}.
+
+Likewise, to import a module provided by Guile---e.g., @code{(srfi
+srfi-1)}---add a @code{use-modules} form in your gexp. Do @emph{not}
+add Guile-provided modules such as @code{(srfi srfi-1)} to a
+@code{with-imported-modules}; doing so would force a potentially
+incompatible version into your environment.
+@end quotation
@end defmac
@defmac with-extensions extensions body@dots{}