diff --git a/doc/latex/install-lib.tex b/doc/latex/install-lib.tex index 55d224d..8c69900 100644 --- a/doc/latex/install-lib.tex +++ b/doc/latex/install-lib.tex @@ -1,6 +1,4 @@ -%% $Id: install-lib.tex,v 1.4 2004/11/08 19:53:28 michel-schinz Exp $ - -%% TODO +%% $Id: install-lib.tex,v 1.5 2005/08/20 15:46:29 michel-schinz Exp $ \documentclass[a4paper,12pt]{article} @@ -334,9 +332,7 @@ therefore hard to find when removing or upgrading a package. Its use should therefore be considered only if third-party tools are available to track files belonging to a package. -%% \subsection{File permissions} - -%% TODO +%% TODO \subsection{File permissions} \subsection{Installation procedure} \label{sec:inst-proc} @@ -388,13 +384,6 @@ to ask for this file to be completely ignored by passing the \cloption{--prefix} and \cloption{--verbose} options. \end{example} -%% \subsection{Creating images} - -%% TODO (my current idea is to add support to install-lib to easily -%% create an image containing the package being installed, and maybe some -%% structures opened. Then, at install time, users could say that they -%% want an image to be created, and the install script would do that). - \section{Using packages} To use a package, its \emph{loading script} must be loaded in @@ -623,12 +612,11 @@ Return the value of the given command-line \param{option} (a symbol). This can be used to get the value of predefined options (like \cloption{--dry-run}) or package-specific options. -\vspace{1em} -\definep{phase-active?}{phase}% +\vspace{1em} \definep{phase-active?}{phase}% Return true iff the given \param{phase} is active, that is if the steps associated with it should be performed. \param{Phase} should be -either the symbol \texttt{build} or the symbol \texttt{install}, -designating the corresponding phase (see section +one of the following symbols: \texttt{build}, \texttt{build-clean} or +\texttt{install}, designating the corresponding phase (see section \ref{sec:packaging-packages}). \subsubsection{Load script generation} @@ -750,8 +738,8 @@ temporary directory and then moved to its final location by some external tool. The \cloption{--phases} option is used to perform only some steps of -the whole installation process. Currently, two phases are defined: -\phase{build} and \phase{install}. +the whole installation process. Currently, three phases are defined: +\phase{build}, \phase{build-clean} and \phase{install}. The \phase{build} phase is the one during which the operations required to build the package are performed. For scsh packages @@ -759,6 +747,9 @@ containing only Scheme code, this phase usually does nothing. For scsh packages containing some C code, this phase is the one during which the C code is compiled. +The \phase{build-clean} phase is the one during which all the files +created during the \phase{build} phase are removed. + The \phase{install} phase is the one during which the files are copied to their final location.