doc: clarifications on pkg-dir and links-file search lists

This commit is contained in:
Matthew Flatt 2021-05-20 07:22:54 -06:00
parent 70f44d9a6c
commit c5fb2d19e3
2 changed files with 7 additions and 4 deletions

View File

@ -85,9 +85,9 @@ directory}:
@item{@indexed-racket['links-search-files] --- like @racket['lib-search-dirs],
but for @tech[#:doc reference-doc]{collection links file}. A @racket[#f]
is replaced by the default search path, which is the user- and version-specific
links file followed by the links file as potentially configured
via @scheme['links-file].}
is replaced by the default search path, which has the links file as potentially configured
via @scheme['links-file]. A user- and version-specific
links file is always added to the beginning of a search.}
@item{@indexed-racket['pkgs-dir] --- a path, string, or byte string
for packages that have @exec{installation} @tech[#:doc '(lib

View File

@ -1459,6 +1459,8 @@ current-system paths while @racket[get-cross-lib-search-dirs] and
order. (Normally, the result includes the result of
@racket[(find-links-file)], which is where new installation-wide
links are installed by @exec{raco link} or @racket[links].) The
result of @racket[find-user-links-file]
is @emph{not} added to the returned list. The
files indicated by the returned paths may or may not exist.
@see-config[links-search-files]}
@ -1482,7 +1484,8 @@ current-system paths while @racket[get-cross-lib-search-dirs] and
Returns a list of paths to the directories containing packages in
installation scope. (Normally, the result includes the result of
@racket[(find-pkgs-dir)], which is where new packages are installed
by @exec{raco pkg install}.) The directories indicated by the returned
by @exec{raco pkg install}.) The result of @racket[find-user-pkgs-dir]
is @emph{not} added to the returned list. The directories indicated by the returned
paths may or may not exist.
@see-config[pkgs-search-dirs]}