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

clarify that config.ss should not be used directly

Browse Source 
svn: r2967
This commit is contained in:
Matthew Flatt 2006-05-18 16:37:47 +00:00
parent f42ea572c2
commit 107bf6b209
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
collects/config/doc.txt
View File

@ -7,7 +7,11 @@ location of directories (such as the main documentation directory) and
also directory search paths (such as a list of directories to search
for documentation).
The library module must export the following values:
Note: instead of `require'ing "config.ss" directly, use the "dirs.ss"
library from "setup", which combines information from "config.ss" and
other sources.
The "config.ss" module must export the following values:
doc-dir - a `delay'ed path/string/bytes for the main documentation
directory; it defaults to a "doc" sibling directory of the main
@ -40,6 +44,10 @@ The library module must export the following values:
In all cases, the value of an exported name can be a `delay'ed #f
(instead of a path/string/bytes or list) to indicate the default.
A user can override an installation's "config.ss" though a "config"
collection in the user's collection directory (which normally takes
precedence over the main collection directory).
The _configtab.ss_ library of the "setup" collection defines a
language module that can be used to implement "config.ss" files. When