document new flesh parameter cactus::info_format

to optionally provide timestamps for CCTK_INFO() / CCTK_VInfo() output

the current implementation uses gettimeofday(2) to provide
microsecond-precision timing info if this is available
(Cactus checks this at configure time), otherwise it falls back
to time(3) (which only gives 1 second precision) which is in
the ISO C standard, and so should be available everywhere...


git-svn-id: http://svn.cactuscode.org/flesh/trunk@3377 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 37 insertions, 0 deletions

diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex
index f8200c13..4140a446 100644
--- a/doc/UsersGuide/Appendices.tex
+++ b/doc/UsersGuide/Appendices.tex
@@ -207,6 +207,9 @@ int* ptr = i;     /* ptr is NOT guaranteed to be a NULL pointer! */
 
 \end{Lentry}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \chapter{Configuration file syntax}
 \label{sec:cofisy}
@@ -696,6 +699,10 @@ scheduling the SCHEDULE WHILE construction should be used.
 
 Conditional constructs cannot be used inside a schedule block.
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \chapter{Schedule bins}
 \label{sec:scbi}
 
@@ -790,6 +797,10 @@ through them.
 
 \end{Lentry}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \chapter{Flesh parameters}
 \label{sec:ccpa}
 
@@ -835,6 +846,17 @@ The size of a cacheline if not set automatically (bytes) [{\tt 0}]
 \item[{\tt recovery\_mode}]
 How to behave when recovering from a checkpoint [{\tt strict}] \{{\tt strict, relaxed}\}
 
+\item[{\tt info\_format}]
+Specifies the content and format of \code{CCTK\_INFO()}/\code{CCTK\_VInfo()}
+messages. [{\tt basic}]
+% don't want lines broken in the middle of one of the keywords!!
+\{%%%
+\hbox{{\tt "basic"}},
+\hbox{{\tt "numeric time stamp"}},
+\hbox{{\tt "human-readable time stamp"}},\\
+\hbox{{\tt "full time stamp"}}%%%
+\}
+
 \end{Lentry}
 
 \section{Restricted parameters}
@@ -861,6 +883,10 @@ Terminate on next iteration ? [{\tt no}]
 
 \end{Lentry}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \chapter{Using {\tt GNATS}}
 GNATS is a freely redistributable set of tools for tracking bug
 reports. It allows users to categorize their problem report and submit
@@ -915,6 +941,10 @@ reports in your shell and from within emacs, respectively.
 
 \label{sec:usgn}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \chapter{Using {\tt CVS}}
 \label{sec:uscv}
 {\tt CVS} is a version control system, which allows you to  keep
@@ -1249,6 +1279,9 @@ home directory which provides menus to pick arrangements and thorns from.
   proper permissions to commit code to the repository.
 \end{Lentry}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \chapter{Using TAGS}
 \label{sec:usta}
@@ -1332,6 +1365,10 @@ at the top of every source file don't have a trailing semicolon, which
 confuses the \texttt{etags} and \texttt{ctags} programs, so TAGS does not find the first
 subroutine in any file with this problem.}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \chapter{ThornLists}
 
 \label{chap:th}