From 8595e13d956d48a80d16cc711f531400320705b5 Mon Sep 17 00:00:00 2001
From: allen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>
Date: Thu, 13 Jan 2000 13:14:16 +0000
Subject: Updates

git-svn-id: http://svn.cactuscode.org/flesh/trunk@1254 17b73243-c579-4c4c-a9d2-2d5706c11dac
---
 doc/MaintGuide/Style.tex             | 17 +++++++++++++++++
 doc/UsersGuide/FunctionReference.tex | 22 +++++++++++++---------
 2 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/doc/MaintGuide/Style.tex b/doc/MaintGuide/Style.tex
index a7537b4e..5a943eb7 100644
--- a/doc/MaintGuide/Style.tex
+++ b/doc/MaintGuide/Style.tex
@@ -57,6 +57,8 @@ statement.
 This brace positioning stategy makes it easy to run ones eye from a closing
 or opening brace to its matching opening or closing brace.
 
+Braces should be used for all {\tt if} and {\tt for} statements.
+
 \section{GRDOC}
 
 All files should start with a grdoc header, and all functions
@@ -115,6 +117,9 @@ extern "C"
 #endif
 \end{verbatim}
 
+The Cactus header files ({\tt cctk\_<name>}) should only include
+information relevant for thorn programmers. 
+
 \section{Source Files}
 
 Source files should have as their first line under the 
@@ -143,6 +148,18 @@ All functions used internally by the flesh should have names beginning with
 Header files to be included by thorns should have names beginning with
 {\tt cctk\_}.
 
+Structures which may be used by thorns should have names beginning with
+{\tt c} and then capitalised words, {\it e.g.} {\tt cGroup}. The 
+exception here is structures associated with utility routines which
+are not Cactus specific, there the structure names should start with a
+{\tt t\_}. 
+
+Structures which are purely internal to the flesh should have
+names beginning with {\tt i}.
+
+All Cactus sourcefile names (except general utility files) should 
+use capitilised words without underscores.
+
 
 
 
diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index 7e66b52f..8f5f9a57 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -963,29 +963,33 @@ No Fortran routine exists at the moment.
 % Groups.c
 \begin{CCTKFunc}{CCTK\_GroupData}{Given a group index, returns information about the variables held in the group.}
 \label{GroupData}
-\subroutine{cGroup}{}{pgroup}
-\argument{int}{integer}{group}
+\function{int}{}{ierr}
+\argument{int}{}{group}
+\argument{cGroup *}{}{pgroup}
 \showcargs
 \begin{params}
-\parameter{pgroup}{Returns a pointer to a structure containing group information}
+\parameter{ierr}{0 for success, negative for failure}
+\parameter{group}{group index}
+\parameter{pgroup}{returns a pointer to a structure containing group information}
 \end{params}
 \begin{discussion}
 The cGroup structure contains the information
 \begin{itemize}
 \item grouptype: The group type
-\item variabletype: The type of variables in the group
-\item staggertype: The type of grid staggering for arrays
+\item vartype: The type of variables in the group
+\item stagtype: The type of grid staggering for arrays
 \item dim: The dimension of variables in the group
-\item numvariables: The number of variables in the group
+\item numvars: The number of variables in the group
 \item ntimelevels: The number of timelevels for variables in the group
 \end{itemize}
 No Fortran routine exists at the moment. 
 \end{discussion}
 \begin{examples}
 \begin{tabular}{@{}p{3cm}cp{11cm}}
-\hfill {\bf C} && {\t index = CCTK\_GroupIndex(`evolve::scalars')}\\
-               &&{\t pgroup = CCTK\_GroupData(index);}\\
-               && {\t vtype = pgroup->variabletype}
+\hfill {\bf C} && {\t cGroup pgroup;}\\
+	       && {\t index = CCTK\_GroupIndex(`evolve::scalars')}\\
+               &&{\t ierr = CCTK\_GroupData(index,\&pgroup);}\\
+               && {\t vtype = pgroup.vartype;}
 \\
 \end{tabular}
 \end{examples}
-- 
cgit v1.2.3