doc tweaks for raco {setup,make}

This commit is contained in:
Matthew Flatt 2015-01-08 09:11:38 -07:00
parent c56c9250f1
commit fe9a04d1db
2 changed files with 14 additions and 12 deletions

View File

@ -123,7 +123,7 @@ would create only @filepath{compiled/b_rkt.zo} and
@; ---------------------------------------------------------------------- @; ----------------------------------------------------------------------
@section{Dependency Files} @section[#:tag "Dependency Files"]{Dependency Files}
In addition to a bytecode file, @exec{raco make} creates a file In addition to a bytecode file, @exec{raco make} creates a file
@filepath{compiled/@nonterm{name}_@nonterm{ext}.dep} that records @filepath{compiled/@nonterm{name}_@nonterm{ext}.dep} that records
@ -538,7 +538,7 @@ messages are instances of a @racket[parallel-compile-event] prefab structure:
@racketblock[ @racketblock[
(struct parallel-compile-event (worker event) #:prefab) (struct parallel-compile-event (worker event) #:prefab)
]. ]
The worker field is the index of the worker that the created the event. The event The worker field is the index of the worker that the created the event. The event
field is a @racket[compile-event] as document in field is a @racket[compile-event] as document in

View File

@ -744,13 +744,14 @@ Optional @filepath{info.rkt} fields trigger additional actions by
module. More specifically, used modules are determined when module. More specifically, used modules are determined when
deleting a @filepath{.dep} file, which would have been created to deleting a @filepath{.dep} file, which would have been created to
accompany a @filepath{.zo} file when the @filepath{.zo} was built accompany a @filepath{.zo} file when the @filepath{.zo} was built
by @exec{raco setup}. If the @filepath{.dep} file indicates another by @exec{raco setup} or @exec{raco make} (see
module, that module's @filepath{.zo} is deleted only if it also has @secref["Dependency\x20Files"]). If the @filepath{.dep} file
an accompanying @filepath{.dep} file. In that case, the indicates another module, that module's @filepath{.zo} is deleted
@filepath{.dep} file is deleted, and additional used modules are only if it also has an accompanying @filepath{.dep} file. In that
deleted based on the used module's @filepath{.dep} file, etc. case, the @filepath{.dep} file is deleted, and additional used
Supplying a specific list of collections to @exec{raco setup} disables modules are deleted based on the used module's @filepath{.dep}
this dependency-based deletion of compiled files.} file, etc. Supplying a specific list of collections to @exec{raco
setup} disables this dependency-based deletion of compiled files.}
] ]
@ -816,9 +817,10 @@ with fewer dependencies.
@subsection{How Dependency Checking Works} @subsection{How Dependency Checking Works}
Dependency checking uses @filepath{.zo} files, associated Dependency checking uses @filepath{.zo} files, associated
@filepath{.dep} files, and the documentation index. Dynamic @filepath{.dep} files (see @secref["Dependency Files"]), and the
references, such as through @racket[dynamic-require], are not visible documentation index. Dynamic references, such as through
to the dependency checker; only dependencies via @racket[require], @racket[dynamic-require], are not visible to the dependency checker;
only dependencies via @racket[require],
@racket[define-runtime-module-path-index], and other forms that @racket[define-runtime-module-path-index], and other forms that
cooperate with @racket[raco make] are visible for dependency checking. cooperate with @racket[raco make] are visible for dependency checking.