summaryrefslogtreecommitdiff
path: root/doc/MaintGuide
diff options
context:
space:
mode:
authorallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2001-08-25 14:44:35 +0000
committerallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2001-08-25 14:44:35 +0000
commitca4a347f4c59b3e78ac3c1ae7b437514b8e237fa (patch)
treeabbe29ba9a15db152520ccac595a4ee5899b089f /doc/MaintGuide
parent34e2ada3a1fcac5dfd88c0124d0f9909035119a5 (diff)
Adding CCTK_FILEVERSION
git-svn-id: http://svn.cactuscode.org/flesh/trunk@2312 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/MaintGuide')
-rw-r--r--doc/MaintGuide/Style.tex19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/MaintGuide/Style.tex b/doc/MaintGuide/Style.tex
index fa6365c2..1cc134fa 100644
--- a/doc/MaintGuide/Style.tex
+++ b/doc/MaintGuide/Style.tex
@@ -164,15 +164,26 @@ There is a template file in the doc/MaintGuide directory.
\section{Source Files}
-Source files should have as their first line after all the include
-files a line containing
+Source files should have as their first lines after all the include
+files:
%\begin{verbatim}
\vskip .3cm
{\bf static const char $*$rcsid = "\$Header\$"; }
+\newline
+{\bf CCTK\_FILEVERSION($<$source file$>$)}
%\end{verbatim}
\vskip .3cm
-or the expanded rcs version of this.
+or the expanded rcs version of this. The macro {\bf CCTK\_FILEVERSION} is
+simply there to prevent compiler warnings, and {\bf $<$source file$>$}
+should be replaced by
+\begin{itemize}
+
+\item{} Flesh: {\bf $<$directory$>$\_$<$core filename$>$\_$<$extension$>$} (e.g. {\bf main\_Groups\_c})
+
+\item{} Thorn: {\bf $<$arrangement$>$\_$<$thorn$>$\_$<$core filename$>$\_$<$extension$>$}\\ (e.g. {\bf CactusBase\_CartGrid3D\_CartGrid3D\_c})
+
+\end{itemize}
Globally visable functions should appear before local
functions.
@@ -192,7 +203,7 @@ All functions used internally by the flesh should have names beginning with
{\tt CCTKi\_} and then capitalised words with no underscores.
Header files to be included by thorns should have names beginning with
-{\tt cctk\_}.
+{\tt cctk\_}, and followed by capitalised words with no underscores.
Structures which may be used by thorns should have names beginning with
{\tt c} and then capitalised words, {\it e.g.} {\tt cGroup}. The