Document the <config>-configinfo and <config>-reconfig makefile targets.

git-svn-id: http://svn.cactuscode.org/flesh/trunk@3902 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 19 insertions, 14 deletions

diff --git a/doc/UsersGuide/RunningCactus.tex b/doc/UsersGuide/RunningCactus.tex
index 9b9a0f79..46c5782e 100644
--- a/doc/UsersGuide/RunningCactus.tex
+++ b/doc/UsersGuide/RunningCactus.tex
@@ -54,7 +54,7 @@ in single processor mode. Please refer to the architecture section
 To use Cactus, with the default driver\footnote{For help with unfamiliar terms, please consult the glossary, Appendix \ref{sec:glossary}.} ({\tt CactusPUGH/PUGH}) on multiple
 processors you also need:
 \begin{Lentry}
-\item[MPI] The \textit{Message Passing Interface} 
+\item[MPI] The \textit{Message Passing Interface}
 which provides inter-processor communication.
 Supercomputing sites often supply a native MPI implementation with
 which Cactus is very likely to be compatible. Otherwise there are
@@ -112,7 +112,7 @@ be found at
 \begin{Lentry}
 \item[\textbf{SGI}] 32 or 64 bit running Irix.
 \item[\textbf{Cray T3E}]
-\item[\textbf{Compaq Alpha}]  Compaq operating system and Linux. 
+\item[\textbf{Compaq Alpha}]  Compaq operating system and Linux.
   Single processor
   mode and MPI supported. The Alphas need to have the GNU C/C++
   compilers installed.
@@ -828,7 +828,7 @@ An empty directory which will contain the object files generated for this
 configuration, and preprocessed source files.
 
 \item [{\tt config-info}]
-A file containing information about the configuration.
+A file containing information about the configuration (including the options used to configure the configuration).
 
 \item [{\tt bindings}] A directory which contains all the files
 generated by the CST from the \texttt{.ccl} files.
@@ -874,7 +874,10 @@ is to do. The command {\tt gmake help} lists all {\tt gmake} targets:
 \item [{\tt gmake <config>-cleanobjs}] removes all object files from
   a configuration.
 
-\item [{\tt gmake <config>-config}] creates a new configuration or reconfigures an old one.
+\item [{\tt gmake <config>-config}] creates a new configuration or reconfigures an existing one overwriting any previous configuration options.\\
+      The configuration options are stored in a file {\tt configs/<config>/config-info}.
+
+\item [{\tt gmake <config>-configinfo}] displays the options used to configure a configuration ({\tt cat configs/<config>/config-info}).
 
 \item [{\tt gmake <config>-cvsupdate}] updates the Flesh and thorns for a configuration using CVS
 
@@ -892,6 +895,8 @@ by configure and the {\tt ThornList} file remain.
 
 \item [{\tt gmake <config>-rebuild}] rebuilds a configuration (reruns the CST).
 
+\item [{\tt gmake <config>-reconfig}] reconfigures an existing configuration using its previous configuration options from the file {\tt configs/<config>/config-info}.
+
 \item [{\tt gmake <config>-testsuite}] runs the test programs associated with
  each thorn in the configuration. See section \ref{sec:testing} for information
  about the test suite mechanism.
@@ -923,8 +928,8 @@ in this configuration.
 Cactus will try to compile all thorns listed in
 {\tt configs/<config>/ThornList}.
 The {\tt ThornList} file is simply a list of the form
-{\tt <arrangement>/<thorn>}.  All text after a pound sign `{\tt \#}' or 
-exclamation mark `{\tt !}' 
+{\tt <arrangement>/<thorn>}.  All text after a pound sign `{\tt \#}' or
+exclamation mark `{\tt !}'
 on a line is treated as a comment and ignored.
 The first time that you compile a configuration, if you did
 not specify a ThornList already during configuration,
@@ -946,7 +951,7 @@ Instead of using the editor to specify the thorns you want to
   have compiled, you can \emph{edit} the {\tt ThornList} outside
   the make process. It is located in {\tt configs/<config>/ThornList},
   where {\tt <config>} refers to the name of your configuration.
-  The directory, {\tt ./configs}, exists \emph{ after} the very first 
+  The directory, {\tt ./configs}, exists \emph{ after} the very first
   make phase for the first configuration.
 
 \subsection{Notes and Caveats}
@@ -1061,7 +1066,7 @@ Cactus executables always run from a parameter file (which may be a
 specified as a command line argument taken from standard input), which
 specifies which
 thorns to use and sets the values of any parameters which are different
-from the default values. There is no restriction on the name 
+from the default values. There is no restriction on the name
 of the parameter file, although it is conventional to use the file
 extension {\tt .par}.  Optional command line arguments can be used
 to customise runtime behaviour, and to provide information about the
@@ -1180,9 +1185,9 @@ The name of a parameter file is often given the suffix {\tt .par}, but
 this is not mandatory.
 
 A parameter file is a text file whose lines are either comments
-or parameter statements. 
+or parameter statements.
 Comments are blank lines or lines that begin with either
-`{\tt \#}' or `{\tt !}'. 
+`{\tt \#}' or `{\tt !}'.
 A parameter statement
 consists of one or more parameter names, followed by
 an `{\tt =}', followed by the value(s) for this (these) parameter(s).
@@ -1276,7 +1281,7 @@ each thorn using the command line options {\tt -o} and {\tt -O}
 \section{Thorn Documentation}
 \label{sec:thdo}
 
-The Cactus make system provides a mechanism for generating a 
+The Cactus make system provides a mechanism for generating a
 \textit{Thorn Guide} containing separate chapters for each thorn and
 arrangement in your configuration. The documentation provided for an
 individual thorn obviously depends on what the thorn authors added,
@@ -1293,7 +1298,7 @@ or to make a Thorn Guide for all the thorns in the {\tt arrangements} directory
 
 {\tt gmake $<$config$>$}.
 
-See Section~\ref{sec:Adding_documentation} for a guide to adding 
+See Section~\ref{sec:Adding_documentation} for a guide to adding
 documentation to your own thorns.
 
 
@@ -1414,10 +1419,10 @@ settings, contents of grid variables, and other relevant information) to a file.
 At a later time, this run can then be restarted from that state by recovering
 all the data from the checkpoint file.
 
-Cactus checkpointing and recovery methods are provided by thorns. 
+Cactus checkpointing and recovery methods are provided by thorns.
 In general, these thorns decide how often to generate a checkpoint.
 They also register their recovery routines with the Flesh; these recovery
-routines may then be called during initialisation of a subsequent run to 
+routines may then be called during initialisation of a subsequent run to
 perform the recovery of the state of the run.
 Such a recovery is requested by setting a parameter in the parameter file.