scsh-conservatory
/
scsh-install-lib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- documented new "build-clean" phase, 

- removed stale comments.
This commit is contained in:
michel-schinz 2005-08-20 15:46:29 +00:00
parent e20914dcbb
commit 7a5796b245
1 changed files with 10 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/latex/install-lib.tex
View File

@ -1,6 +1,4 @@
%% $Id: install-lib.tex,v 1.4 2004/11/08 19:53:28 michel-schinz Exp $ %% $Id: install-lib.tex,v 1.5 2005/08/20 15:46:29 michel-schinz Exp $
%% TODO
\documentclass[a4paper,12pt]{article} \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 should therefore be considered only if third-party tools are available
to track files belonging to a package. to track files belonging to a package.
%% \subsection{File permissions} %% TODO \subsection{File permissions}
%% TODO
\subsection{Installation procedure} \subsection{Installation procedure}
\label{sec:inst-proc} \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. \cloption{--prefix} and \cloption{--verbose} options.
\end{example} \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} \section{Using packages}
To use a package, its \emph{loading script} must be loaded in 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 This can be used to get the value of predefined options (like
\cloption{--dry-run}) or package-specific options. \cloption{--dry-run}) or package-specific options.
\vspace{1em} \vspace{1em} \definep{phase-active?}{phase}%
\definep{phase-active?}{phase}%
Return true iff the given \param{phase} is active, that is if the Return true iff the given \param{phase} is active, that is if the
steps associated with it should be performed. \param{Phase} should be steps associated with it should be performed. \param{Phase} should be
either the symbol \texttt{build} or the symbol \texttt{install}, one of the following symbols: \texttt{build}, \texttt{build-clean} or
designating the corresponding phase (see section \texttt{install}, designating the corresponding phase (see section
\ref{sec:packaging-packages}). \ref{sec:packaging-packages}).
\subsubsection{Load script generation} \subsubsection{Load script generation}
@ -750,8 +738,8 @@ temporary directory and then moved to its final location by some
external tool. external tool.
The \cloption{--phases} option is used to perform only some steps of The \cloption{--phases} option is used to perform only some steps of
the whole installation process. Currently, two phases are defined: the whole installation process. Currently, three phases are defined:
\phase{build} and \phase{install}. \phase{build}, \phase{build-clean} and \phase{install}.
The \phase{build} phase is the one during which the operations The \phase{build} phase is the one during which the operations
required to build the package are performed. For scsh packages 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 packages containing some C code, this phase is the one during which
the C code is compiled. 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 The \phase{install} phase is the one during which the files are copied
to their final location. to their final location.