suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve docs for compile-file

Browse Source 
Clarify that it expects to be called via
`with-module-reading-parameterization`.

Closes #1291
This commit is contained in:
Matthew Flatt 2016-04-16 10:56:50 -06:00
parent 446b93882c
commit 467979cd8b
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
pkgs/racket-doc/scribblings/raco/make.scrbl
View File

@ -9,7 +9,10 @@
compiler/cm
compiler/cm-accomplice
setup/parallel-build
compiler/compilation-path))
compiler/compilation-path
compiler/compile-file
syntax/modread
(only-in compiler/compiler compile-zos)))
@(define cm-eval (make-base-eval))
@ -692,8 +695,13 @@ destination file's path.
If the @racket[filter] procedure is provided, it is applied to each
source expression, and the result is compiled.
The @racket[compile-file] procedure is designed for compiling modules
files, in that each expression in @racket[src] is compiled
Beware that @racket[compile-file] uses the current reader
parameterization to read @racket[src]. Typically,
@racket[compile-file] should be called from a thunk passed to
@racket[with-module-reading-parameterization] so that the source
program is parsed in a consistent way and allowing @hash-lang[].
Each expression in @racket[src] is compiled
independently. If @racket[src] does not contain a single
@racket[module] expression, then earlier expressions can affect the
compilation of later expressions when @racket[src] is loaded