summaryrefslogtreecommitdiff
path: root/doc/MaintGuide
diff options
context:
space:
mode:
authorgoodale <goodale@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-13 13:41:29 +0000
committergoodale <goodale@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-13 13:41:29 +0000
commitd4c446834e757cd66afc7d514f86e42fe05b3618 (patch)
tree10beacef171cd6e42980ab4b140c5259c7ac82aa /doc/MaintGuide
parent8595e13d956d48a80d16cc711f531400320705b5 (diff)
Stopped CVS from expanding the $Header$ in an example.
Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@1255 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/MaintGuide')
-rw-r--r--doc/MaintGuide/Style.tex12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/MaintGuide/Style.tex b/doc/MaintGuide/Style.tex
index 5a943eb7..14d080d2 100644
--- a/doc/MaintGuide/Style.tex
+++ b/doc/MaintGuide/Style.tex
@@ -125,9 +125,11 @@ information relevant for thorn programmers.
Source files should have as their first line under the
grdoc header a line containing
-\begin{verbatim}
-static char *rcsid = "$Header$"
-\end{verbatim}
+%\begin{verbatim}
+\vskip .3cm
+{\bf static char \*rcsid = "\$Header\$"; }
+%\end{verbatim}
+\vskip .3cm
or the expanded rcs version of this.
Globally visable functions should appear before local
@@ -140,10 +142,10 @@ src/main/ScheduleInterface.c )
\section{Naming Conventions}
All functions which may be used by thorns should have names beginning
-with {\tt CCTK\_}.
+with {\tt CCTK\_} and then capitalised words with no underscores.
All functions used internally by the flesh should have names beginning with
-{\tt CCTKi\_}.
+{\tt CCTKi\_} and then capitalised words with no underscores.
Header files to be included by thorns should have names beginning with
{\tt cctk\_}.