From 98c459c3d746eb204de23743f1403c41a23740ab Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Wed, 4 Jul 2012 17:36:30 -0500 Subject: [PATCH] document the fact that resolve-planet-path is exported from 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 --- collects/planet/private/util.scrbl | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/collects/planet/private/util.scrbl b/collects/planet/private/util.scrbl index 562f8b8586..97092894d9 100644 --- a/collects/planet/private/util.scrbl +++ b/collects/planet/private/util.scrbl @@ -46,7 +46,18 @@ the resolvers behavior. } @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?]{ @@ -455,10 +466,9 @@ procedure signals an error if no such link exists, unless @defproc[(resolve-planet-path [spec quoted-planet-require-spec?]) path?]{ -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.} +This is the same function as the one with the same name, +exported by @racketmodname[planet/resolver]. +} @defproc[(path->package-version [p path?]) (or/c (list/c string? string? natural-number/c natural-number/c) #f)]{