Changeset 4273

Timestamp:

Jun 15, 2005, 9:57:10 AM (21 years ago)

Author:

eugene

Message:

updates to trace/log

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (3 diffs)
• psLibSDRS.tex (modified) (11 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.146 2005-06-15 02:58:05 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.147 2005-06-15 19:57:10 eugene Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -577 +577 @@
 \end{itemize}
 
-\subsection{Changes from Revision 14 (27 April 2005) to Revision 15 (...)}
+\subsection{Changes from Revision 14 (27 April 2005) to Revision 15 (15 June 2005)}
 
 \begin{itemize}
@@ -726 +726 @@
 \item add \code{limit} param to \code{psDBDeleteRows()}
 \item change \code{p_psDBRunQuery()} to accept a \code{printf()} style format 
-\end{itemize}
+\item added F (file:line) to psLogMsg and psTrace
+\item added psLogGetLevel
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.289 2005-06-15 02:58:05 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.290 2005-06-15 19:57:10 eugene Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -11 +11 @@
 \project{Pan-STARRS Image Processing Pipeline}
 \organization{Institute for Astronomy}
-\version{14}
+\version{15}
 \docnumber{PSDC-430-007}
 
@@ -43 +43 @@
 10 & 2004 Nov 30 & update for cycle 4 \\ \hline
 11 & 2005 Jan 21 & draft for cycle 5 \\ \hline
-12 & 2005 Feb 09 & final for cycle 5 \\
-13 & 2005 Mar 30 & draft for cycle 6 \\
-14 & 2005 Apr 27 & final for cycle 6 \\
+12 & 2005 Feb 09 & final for cycle 5 \\ \hline
+13 & 2005 Mar 30 & draft for cycle 6 \\ \hline
+14 & 2005 Apr 27 & final for cycle 6 \\ \hline
+15 & 2005 Jun 15 & draft for cycle 7 \\ \hline
 \RevisionsEnd
 
@@ -157 +158 @@
 
 \begin{itemize}
-\item The memory management functions, defined below, must be written
-  to be thread-safe, since we cannot risk this crucial area being
+\item The memory management and error stack functions, defined below
+  (Sections~\ref{sec:memory} \&~\ref{sec:errors}), must be written to
+  be thread-safe, since we cannot risk this crucial area being
   unstable.
 \item Re-entrant versions of system calls and external library
   functions should be used.  We expect that these cases are
   sufficiently small that we are prepared to err on the side of
-  caution.
+  caution. 
 \item The practise of using \code{static} variable to achieve high
   efficiency (e.g., so that subsequent calls do not have to repeat a
@@ -315 +317 @@
 
 \subsubsection{Memory Management}
+\label{sec:memory}
 
 In the following sections, we specify the API set and define the
@@ -1219 +1222 @@
 %
 which expects a string consisting of the letters \code{H} (host),
-\code{L} (level), \code{M} (message), \code{N} (name), and \code{T}
-(time).  The default is \code{THLNM}, which produces trace messages in
-the form:
+\code{L} (level), \code{M} (message), \code{N} (name), \code{F}
+(file:name), and \code{T} (time).  The default is \code{THLNM}, which
+produces trace messages in the form:
 \begin{verbatim}
-YYYY-MM-DD hh:mm:ssZ | hostname | L | name
+YYYY-MM-DD hh:mm:ssZ | hostname | L | name | file:line
     The message goes here
     and is indented by 4 spaces.
@@ -1229 +1232 @@
 where \code{YYYY}, \code{MM}, \code{DD}, \code{hh}, \code{mm}, and
 \code{ss} are the year, month (Jan is 01), day of the month, hours
-(0--23), minutes, and seconds when the trace message was received.  Note
-that the timestamp is in ISO order, and that the timezone is GMT
+(0--23), minutes, and seconds when the trace message was received.
+Note that the timestamp is in ISO order, and that the timezone is GMT
 (hence the \code{Z}).  The \code{hostname} is returned by
-\code{gethostname}, \code{L} is a character associated with the level
-(\code{A}, \code{E}, \code{W}, and \code{I} for \code{PS_LOG_ABORT},
-\code{PS_LOG_ERROR}, \code{PS_LOG_WARN}, and \code{PS_LOG_INFO}
-respectively. Other levels are represented numerically (\code{5}
-etc.). The other two fields, \code{facil} and \code{msg}, are the
-arguments to \code{psTrace}.  The \code{msg} is placed on a new line
-(allowing the \code{name} to fill the rest of the previous line),
-with each line indented by 4 spaces.  An example message is:
+\code{gethostname}, \code{L} is the numerical level. The other two
+fields, \code{name} and \code{msg}, are the facility name and the
+complete message provided to \code{psTrace}.  The \code{msg} is placed
+on a new line (allowing the \code{name} to fill the rest of the
+previous line), with each line indented by 4 spaces.  An example
+message is:
 %
 \begin{verbatim}
-2004:02:24 20:14:18Z | alibaba.IfA.Hawaii.Edu | I | example.utils.helloWorld
+2004:02:24 20:14:18Z | alibaba.IfA.Hawaii.Edu | I | example.utils.helloWorld | example.c:20
     Hello world,
     it's me calling.
@@ -1308 +1309 @@
 \code{PS_LOG_INFO}.
 
+\begin{prototype}
+int psLogGetLevel();           
+\end{prototype}
+%
+This function returns the current log level.  
+
 Log messages are sent to the destination most recently set using:
 %
@@ -1334 +1341 @@
 %
 which expects a string consisting of the letters \code{H} (host),
-\code{L} (level), \code{M} (message), \code{N} (name), and \code{T}
-(time).  The default is \code{THLNM}, which produces log messages in
-the form:
+\code{L} (level), \code{M} (message), \code{N} (name), \code{F}
+(file:line), and \code{T} (time).  The default is \code{THLNM}, which
+produces log messages in the form:
 \begin{verbatim}
-YYYY-MM-DD hh:mm:ssZ | hostname | L | name
+YYYY-MM-DD hh:mm:ssZ | hostname | L | name | file:line
     The message goes here
     and is indented by 4 spaces.
@@ -1391 +1398 @@
 
 \subsection{Error Handling}
+\label{sec:errors}
 \hlabel{errorStack}
 
@@ -1400 +1408 @@
 returns the error code.
 \begin{prototype}
-psErrorCode p_psError(const char *filename, unsigned int lineno, const char *func, psErrorCode code,
-                      bool new, const char *format, ...);
-\end{prototype}
-\begin{datatype}
-#define psError(code, new, format, ...) psError(__FILE__, __LINE__, __func__, code, new, format, __VA_ARGS__)
+psErrorCode p_psError(const char *filename, 
+                      unsigned int lineno, 
+                      const char *func, 
+                      psErrorCode code,
+                      bool new, 
+                      const char *format, ...);
+\end{prototype}
+\begin{datatype}
+#define psError(code, new, format, ...) \
+    p_psError(__FILE__, __LINE__, __func__, code, new, format, __VA_ARGS__)
 \end{datatype}