2 Package Utilities
This module provides definitions to easily create PLaneT packages
along with their documentation (using the automatic scribble parser,
see Scribble Definition Parser).
All the functions of this module are meant to be used
is correctly set to the
directory of your package. This is generally true when evaluating
a file of your package in DrScheme.
They are also relative to some parameters. Either set them
to correct values directly or use set-planet-env
If you only need to use planet-build
, then you can call it with the parameters
values, which will be set temporarily.
A parameter controlling the name of the package.
By default it is the name of the current directory.
A parameter controlling the major-version number of the current package (default: 1).
A parameter controlling the minor-version number of the current package (default: 0).
A parameter controlling the owner name of the current package.
By default it is the username of the OS environment or "my-username"
if none is found.
Creates a environment suitable for calling the functions of this module,
by setting the package-owner
parameters to the given values.
Call this function before any other if you want to change the default values
of the parameters.
Launches the "planet"
executable with the "create" option.
The package file is put in the parent directory of the package.
Using the planet executable seems to provide more debug info than
Launches the "planet"
executable with the "file-inject" option
on the current package file in the parent directory of the current-directory
The package file must exist.
on the current package environment settings.
Creates the whole Scribble string associated
, automatically looking for the provided definitions
) and adding header information.
Writes the ".scrbl"
file associated with file
in the directory dir
argument is the same as for with-output-to-file
argument is the same as for build-path
(Re)writes the main source file of the package, using require-provide
for each file of the package.
Writes the main ".scrbl"
file in the dir
directory with a table of contents.
a warning and does not overwrite the file.
If modules have been added to the package since the last
execution of (planet-build)
either the user should delete the main
file so that it will be rewritten,
or the user should add the inclusion of the modules himself in the
Writes a stub of the the "info.ss"
file that ought to be modified
by the user.
The argument dir
is the sub-directory of the documentation.
for information about the exists
if they are provided.
, and creates the documentation
if it does not already exist.
(Re)writes the ".scrbl" file for all other ".ss" or ".scm" file
in the directory (but not in sub-directories), without warning.
An exception list of files that must not be included
in the process can be given through except.
Deletes all ".bak" files, in the current directory and
its sub-directories, that may have been created by DrScheme.
Does not (yet) deletes "~" files under Unix.
Creates a PLaneT hard link to the current directory
so that it is considered as a package.
Removes the planet hard link of the current package.