Changeset 9815 for trunk/doc/config/config.tex

Timestamp:

Oct 31, 2006, 4:54:16 PM (20 years ago)

Author:

Paul Price

Message:

Adding more information for recipes: symbolic links and precedence.

Location:

trunk/doc/config

Files:

• . (modified) (1 prop)
• config.tex (modified) (2 diffs)

trunk/doc/config/config.tex

@@ -1 @@
-%%% $Id: config.tex,v 1.3 2006-10-20 22:07:17 price Exp $
+%%% $Id: config.tex,v 1.4 2006-11-01 02:54:16 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1176 +1176 @@
 the \code{PATH(STR)} in the site configuration defines the search
 paths for these files.
+
+\subsubsection{Symbolic links}
+
+Symbolic links to another recipe may be specified on the command line,
+removing the need for the user to memorise a file name: e.g.,
+\code{-recipe PPIMAGE PPIMAGE_BIAS} might perform a bias subtraction
+only.  A symbolic link is recognised as such if the value is the name
+of a recipe that has already been read (and the link is immediately
+resolved), or if no filename of that name exists (in which case the
+link is to be resolved later, as further sources become available).
+
+\subsubsection{Precedence}
+
+If multiple recipes have the same name, the precedence order is:
+\begin{enumerate}
+\item Command-line
+\item Camera configuration
+\item Site configuration
+\end{enumerate}
+with sources higher in this list having greater precedence.  This
+allows the user to override any recipes using the command-line, and to
+specify bottom-level defaults in the site configuration while also
+having camera-specific recipes in the camera configurations.
 
 \subsection{Contents}