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

document the fact that resolve-planet-path is exported from

Browse Source 
two different modules. Not sure who might be using this, so
it seems unwise to actually fix this problem.

Also document the fact that calling this function is unlikely
to be useful unless you know the package is already installed.

closes PR 12719
This commit is contained in:
Robby Findler 2012-07-04 17:36:30 -05:00
parent d79db54a22
commit 98c459c3d7
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
collects/planet/private/util.scrbl
View File

@ -46,7 +46,18 @@ the resolvers behavior.
} }
@defproc[(resolve-planet-path [planet-path any/c]) path?]{ @defproc[(resolve-planet-path [planet-path any/c]) path?]{
Returns the path where the file named by the require spec @racket[planet-path] is located in the current installation. Returns the file system path to the file specified by the given quoted
@|PLaneT| require specification. This function downloads and installs the
specified package if necessary, but does not verify that the actual
file within it actually exists.
If the @|PLaneT| package is not actually installed, then this function expects
to be called with a very powerful security guard, one that is available to
the built-in module name resolver, but not generally available to user code.
So probably this function will fail (possibly deadlock).
This is the same function as the one with the same name,
exported by @racketmodname[planet/util].
} }
@defparam[download? dl? boolean?]{ @defparam[download? dl? boolean?]{
@ -455,10 +466,9 @@ procedure signals an error if no such link exists, unless
@defproc[(resolve-planet-path [spec quoted-planet-require-spec?]) @defproc[(resolve-planet-path [spec quoted-planet-require-spec?])
path?]{ path?]{
Returns the file system path to the file specified by the given quoted This is the same function as the one with the same name,
planet require specification. This function downloads and installs the exported by @racketmodname[planet/resolver].
specified package if necessary, but does not verify that the actual }
file within it actually exists.}
@defproc[(path->package-version [p path?]) @defproc[(path->package-version [p path?])
(or/c (list/c string? string? natural-number/c natural-number/c) #f)]{ (or/c (list/c string? string? natural-number/c natural-number/c) #f)]{