diff options
author | eschnett <eschnett@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2013-03-05 05:08:33 +0000 |
---|---|---|
committer | eschnett <eschnett@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2013-03-05 05:08:33 +0000 |
commit | 9cff90a8e99f1df4fbc651ada92283a01588623f (patch) | |
tree | 67a402515a6b479e567b44b7ee336f6a82763280 /doc | |
parent | 638398785d624541bb8bd0c0f70b9eb3f8820e9b (diff) |
Correct documenation of CCTK_Abort
git-svn-id: http://svn.cactuscode.org/flesh/trunk@4975 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ReferenceManual/CCTKReference.tex | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex index 5900e180..eea96db3 100644 --- a/doc/ReferenceManual/CCTKReference.tex +++ b/doc/ReferenceManual/CCTKReference.tex @@ -874,16 +874,17 @@ Abnormal Cactus termination. \begin{verbatim} #include "cctk.h" -int dummy = CCTK_Abort(const cGH *cctkGH); +int dummy = CCTK_Abort(const cGH *cctkGH, int exitcode); \end{verbatim} \end{Synopsis} \begin{Synopsis}{Fortran} \begin{verbatim} #include "cctk.h" -subroutine CCTK_Abort (dummy, cctkGH) +subroutine CCTK_Abort (dummy, cctkGH, exitcode) integer dummy CCTK_POINTER cctkGH + integer exitcode end subroutine CCTK_Abort \end{verbatim} \end{Synopsis} @@ -899,6 +900,9 @@ The function never returns, and hence never produces a result. \begin{Parameter}{GH ($\ne$ NULL)} Pointer to a valid Cactus grid hierarchy. \end{Parameter} +\begin{Parameter}{exitcode} +Exit code that is passed to the operating system +\end{Parameter} \end{ParameterSection} \begin{Discussion} @@ -3096,7 +3100,7 @@ integer value \end{verbatim} pointer to CCTK grid hierarchy \end{Parameter} \begin{Parameter}{value} -the return code to abort with +the return code to exit with \end{Parameter} \end{ParameterSection} \begin{Discussion} |