Start of the maintainers guide.

Tom


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

1 files changed, 38 insertions, 0 deletions

diff --git a/doc/MaintGuide/CST.tex b/doc/MaintGuide/CST.tex
new file mode 100644
index 00000000..29d3fed0
--- /dev/null
+++ b/doc/MaintGuide/CST.tex
@@ -0,0 +1,38 @@
+% /*@@
+%   @file      CST.tex
+%   @date      Wed Jan 12 14:38:29 2000
+%   @author    Tom Goodale
+%   @desc 
+%   
+%   @enddesc 
+%   @version $Header$
+% @@*/
+
+\begin{cactuspart}{3}{The CST}{$RCSfile$}{$Revision$}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
+
+\chapter{Introduction}
+
+The CST is really the glue which holds the code together.  It takes the 
+specifications which users have provided in their {\em .ccl} files
+and generates C header and source files which are used to tell the 
+flesh about the thorns.
+
+The processing is done in three stages.  In the first stage the {\em .ccl}
+files from each thorn in the {\em ThornList} are parsed and the data from them
+is stored internally in databases.  In the second stage the data is 
+cross-indexed for consistency.  Finally the files are written out into the 
+{\em bindings} directory in the configuration directory.
+
+\chapter{The Databases}
+
+\chapter{The Generated Files}
+
+\chapter{The Parsing Routines}
+
+\chapter{The Output Routines}
+
+\chapter{Miscellaneous Routines}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\end{cactuspart}