Next: , Previous: , Up: Controlling where ASDF saves compiled files   [Contents][Index]


9.8 Output location API

The specified functions are exported from package ASDF.

Function: initialize-output-translations &optional PARAMETER

will read the configuration and initialize all internal variables. You may extend or override configuration from the environment and configuration files with the given PARAMETER, which can be nil (no configuration override), or a SEXP (in the SEXP DSL), a string (as in the string DSL), a pathname (of a file or directory with configuration), or a symbol (fbound to function that when called returns one of the above).

Function: disable-output-translations

will initialize output translations in a way that maps every pathname to itself, effectively disabling the output translation facility.

Function: clear-output-translations

undoes any output translation configuration and clears any cache for the mapping algorithm. You might want to call this function (or better, clear-configuration) before you dump an image that would be resumed with a different configuration, and return an empty configuration. Note that this does not include clearing information about systems defined in the current image, only about where to look for systems not yet defined.

Function: ensure-output-translations &optional PARAMETER

checks whether output translations have been initialized. If not, initialize them with the given PARAMETER. This function will be called before any attempt to operate on a system.

Function: apply-output-translations PATHNAME

Applies the configured output location translations to PATHNAME (calls ensure-output-translations for the translations).

Every time you use ASDF’s output-files, or anything that uses it (that may compile, such as operate, perform, etc.), ensure-output-translations is called with parameter nil, which the first time around causes your configuration to be read. If you change a configuration file, you need to explicitly initialize-output-translations again, or maybe clear-output-translations (or clear-configuration), which will cause the initialization to happen next time around.


Next: , Previous: , Up: Controlling where ASDF saves compiled files   [Contents][Index]