summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2011-02-15 12:31:02 +0100
committerLudovic Courtès <ludo@gnu.org>2011-02-15 12:31:02 +0100
commit14d2ee311642338381e356ff0baa559e9a91bb8c (patch)
treed825d896ccf08d25a910d22f73be1185cce29304
parentbb5b36d069344da02c147bd794b0733bfa67503c (diff)
downloadguile-14d2ee311642338381e356ff0baa559e9a91bb8c.tar.gz
Document `%auto-compilation-options'.
* doc/ref/api-evaluation.texi (Compilation): Emphasize auto-compilation. Document `%auto-compilation-options'.
-rw-r--r--doc/ref/api-evaluation.texi14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/ref/api-evaluation.texi b/doc/ref/api-evaluation.texi
index 54bdbefbd..b976715db 100644
--- a/doc/ref/api-evaluation.texi
+++ b/doc/ref/api-evaluation.texi
@@ -534,11 +534,13 @@ interpreter.
Functions from system modules in a Guile installation are normally
compiled already, so they load and run quickly.
+@cindex automatic compilation
Note that well-written Scheme programs will not typically call the
procedures in this section, for the same reason that it is often bad
-taste to use @code{eval}. The normal interface to the compiler is the
-command-line file compiler, which can be invoked from the shell as
-@code{guile-tools compile foo.scm}.
+taste to use @code{eval}. By default, Guile automatically compiles any
+files it encounters that have not been compiled yet (@pxref{Invoking
+Guile, @code{--auto-compile}}). The compiler can also be invoked
+explicitly from the shell as @code{guile-tools compile foo.scm}.
(Why are calls to @code{eval} and @code{compile} usually in bad taste?
Because they are limited, in that they can only really make sense for
@@ -638,6 +640,12 @@ should pass the @var{output-file} option to @code{compile-file},
explicitly.
@end deffn
+@defvr {Scheme Variable} %auto-compilation-options
+This variable contains the options passed to the @code{compile-file}
+procedure when auto-compiling source files. By default, it enables
+useful compilation warnings. It can be customized from @file{~/.guile}.
+@end defvr
+
@node Loading
@subsection Loading Scheme Code from File