get-root-set docs clarification

This commit is contained in:
Robby Findler 2014-02-26 17:55:18 -06:00
parent 30c49028cb
commit 60948fabf4

View File

@ -86,6 +86,11 @@ Determines if @racket[v] is a root.
Returns the current @racket[root?]s as a list. This returns Returns the current @racket[root?]s as a list. This returns
valid roots only when invoked via the mutator language. Otherwise valid roots only when invoked via the mutator language. Otherwise
it returns only what has been set up with @racket[with-roots]. it returns only what has been set up with @racket[with-roots].
Note that if your collector is being invoked via @racket[gc:cons]
or @racket[gc:closure], then there may be live data that is
not reachable via the result of @racket[get-root-set], but that
is reachable via the roots passed as arguments to those functions.
} }
@defproc[(read-root (root root?)) location?]{ @defproc[(read-root (root root?)) location?]{