From fe9a04d1db4d59753ffc224ea39d3a1e0dc9616e Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Thu, 8 Jan 2015 09:11:38 -0700 Subject: [PATCH] doc tweaks for `raco {setup,make}` --- pkgs/racket-doc/scribblings/raco/make.scrbl | 4 ++-- pkgs/racket-doc/scribblings/raco/setup.scrbl | 22 +++++++++++--------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/pkgs/racket-doc/scribblings/raco/make.scrbl b/pkgs/racket-doc/scribblings/raco/make.scrbl index 8cb2f8edbb..c979104ca9 100644 --- a/pkgs/racket-doc/scribblings/raco/make.scrbl +++ b/pkgs/racket-doc/scribblings/raco/make.scrbl @@ -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 @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[ (struct parallel-compile-event (worker event) #:prefab) -]. +] 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 diff --git a/pkgs/racket-doc/scribblings/raco/setup.scrbl b/pkgs/racket-doc/scribblings/raco/setup.scrbl index 7fb1276789..328012e168 100644 --- a/pkgs/racket-doc/scribblings/raco/setup.scrbl +++ b/pkgs/racket-doc/scribblings/raco/setup.scrbl @@ -744,13 +744,14 @@ Optional @filepath{info.rkt} fields trigger additional actions by module. More specifically, used modules are determined when deleting a @filepath{.dep} file, which would have been created to accompany a @filepath{.zo} file when the @filepath{.zo} was built - by @exec{raco setup}. If the @filepath{.dep} file indicates another - module, that module's @filepath{.zo} is deleted only if it also has - an accompanying @filepath{.dep} file. In that case, the - @filepath{.dep} file is deleted, and additional used modules are - deleted based on the used module's @filepath{.dep} file, etc. - Supplying a specific list of collections to @exec{raco setup} disables - this dependency-based deletion of compiled files.} + by @exec{raco setup} or @exec{raco make} (see + @secref["Dependency\x20Files"]). If the @filepath{.dep} file + indicates another module, that module's @filepath{.zo} is deleted + only if it also has an accompanying @filepath{.dep} file. In that + case, the @filepath{.dep} file is deleted, and additional used + modules are deleted based on the used module's @filepath{.dep} + 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} Dependency checking uses @filepath{.zo} files, associated -@filepath{.dep} files, and the documentation index. Dynamic -references, such as through @racket[dynamic-require], are not visible -to the dependency checker; only dependencies via @racket[require], +@filepath{.dep} files (see @secref["Dependency Files"]), and the +documentation index. Dynamic references, such as through +@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 cooperate with @racket[raco make] are visible for dependency checking.