summaryrefslogtreecommitdiff
path: root/doc/MaintGuide
diff options
context:
space:
mode:
authorallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-13 13:14:16 +0000
committerallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-13 13:14:16 +0000
commit8595e13d956d48a80d16cc711f531400320705b5 (patch)
tree5e630025e0f4eb6888210212ecd8e2251536887b /doc/MaintGuide
parent270851063277379044ed7f1605bfc0f2715e35ef (diff)
Updates
git-svn-id: http://svn.cactuscode.org/flesh/trunk@1254 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/MaintGuide')
-rw-r--r--doc/MaintGuide/Style.tex17
1 files changed, 17 insertions, 0 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.
+