summaryrefslogtreecommitdiff
path: root/doc/UsersGuide/RunningCactus.tex
diff options
context:
space:
mode:
authortradke <tradke@17b73243-c579-4c4c-a9d2-2d5706c11dac>2005-09-19 15:27:46 +0000
committertradke <tradke@17b73243-c579-4c4c-a9d2-2d5706c11dac>2005-09-19 15:27:46 +0000
commitc3b68f42efd77709e85be5585b6c26ccd70d5cec (patch)
tree2211fe96ffc1a12e567db1eb4e4fa885fadfbd9c /doc/UsersGuide/RunningCactus.tex
parent2ce52bc090f0edc30092ccd7d376d35dd2e33856 (diff)
Document missing documentation build targets
gmake <arrangement>-ArrangementDoc gmake ReferenceManual git-svn-id: http://svn.cactuscode.org/flesh/trunk@4134 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide/RunningCactus.tex')
-rw-r--r--doc/UsersGuide/RunningCactus.tex44
1 files changed, 26 insertions, 18 deletions
diff --git a/doc/UsersGuide/RunningCactus.tex b/doc/UsersGuide/RunningCactus.tex
index b2faa7c8..725f2ec2 100644
--- a/doc/UsersGuide/RunningCactus.tex
+++ b/doc/UsersGuide/RunningCactus.tex
@@ -903,7 +903,7 @@ is to do. The command {\tt gmake help} lists all {\tt gmake} targets:
\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
+\item[{\tt gmake <config>-cvsupdate}] updates the Flesh and this configuration's thorns from the CVS repositories.
\item [{\tt gmake <config>-delete}] deletes a configuration ({\tt rm -r configs/<config>}).
@@ -925,22 +925,13 @@ by configure and the {\tt ThornList} file remain.
each thorn in the configuration. See section \ref{sec:testing} for information
about the test suite mechanism.
-\item [{\tt gmake <config>-thornlist}] regenerates the {\tt ThornList} for a configuration.
-
-\item [{\tt gmake <config>-utils [UTILS$=$<list>]}] builds all utility programs provided by the thorns of a configuration. Individual utilities can be selected by giving their names in the {\tt UTILS} variable.
-
\item[{\tt gmake <config>-ThornGuide}] builds documentation for the thorns
-in this configuration.
-
-\item[{\tt gmake <thorn>-ThornDoc}] builds the documentation for the thorn.
-
-\item[{\tt gmake ThornDoc}] builds the documentation for all thorns.
+in this configuration
+ (see section \ref{sec:OtherGmakeTargetsDoc} on page \pageref{sec:OtherGmakeTargetsDoc} for other targets to build documentation for thorns).
-\item[{\tt gmake ArrangementDoc}] builds the documentation for all arrangements.
-
-\item[{\tt gmake <config>-configinfo}] displays the options used to build the configuration.
+\item [{\tt gmake <config>-thornlist}] regenerates the {\tt ThornList} for a configuration.
-\item[{\tt gmake <config>-cvsupdate}] updates the Flesh and this configuration's thorns from the CVS repositories.
+\item [{\tt gmake <config>-utils [UTILS$=$<list>]}] builds all utility programs provided by the thorns of a configuration. Individual utilities can be selected by giving their names in the {\tt UTILS} variable.
\end{Lentry}
@@ -1033,6 +1024,9 @@ the Cactus root directory. % (usually \texttt{Cactus}).
\item [{\tt gmake cvsupdate}] updates Flesh and all thorns from CVS repositories.
+\item [{\tt gmake configinfo}] prints configuration options for every
+configuration found in user's \texttt{configs} subdirectory.
+
\item [{\tt gmake default}] creates a new configuration with a default name.
\item [{\tt gmake distclean}] deletes your {\tt configs} directory and hence all your configurations.
@@ -1049,14 +1043,28 @@ the Cactus root directory. % (usually \texttt{Cactus}).
\item [{\tt gmake tags}] creates a {\tt vi} style tags file. See section
\ref{sec:Appendix.tags} for using tags within Cactus.
-\item [{\tt gmake UsersGuide}] runs LaTeX to produce a copy of the Users' Guide.
+\end{Lentry}
-\item [{\tt gmake ThornGuide}] runs LaTeX to produce a copy of the Thorn Guide, for all the thorns in the arrangements directory.
+{\bf Targets to generate Cactus documentation:}
+\label{sec:OtherGmakeTargetsDoc}
+
+\begin{Lentry}
+
+\item[{\tt gmake <arrangement>-ArrangementDoc}] builds the documentation for the arrangement.
+
+\item[{\tt gmake ArrangementDoc}] builds the documentation for all arrangements.
\item [{\tt gmake MaintGuide}] runs LaTeX to produce a copy of the Maintainers' Guide.
-\item [{\tt gmake configinfo}] prints configuration options for every
-configuration found in user's \texttt{configs} subdirectory.
+\item [{\tt gmake ReferenceManual}] runs LaTeX to produce a copy of the Reference Manual.
+
+\item[{\tt gmake <thorn>-ThornDoc}] builds the documentation for the thorn.
+
+\item[{\tt gmake ThornDoc}] builds the documentation for all thorns.
+
+\item [{\tt gmake ThornGuide}] runs LaTeX to produce a copy of the Thorn Guide, for all the thorns in the arrangements directory.
+
+\item [{\tt gmake UsersGuide}] runs LaTeX to produce a copy of the Users' Guide.
\end{Lentry}