Changeset 4860

Timestamp:

Aug 23, 2005, 3:38:16 PM (21 years ago)

Author:

Paul Price

Message:

Clarified behaviour of psLogSetDestination and psTraceSetDestination

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• psLibSDRS.tex (modified) (4 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.163 2005-08-05 20:24:03 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.164 2005-08-24 01:38:16 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -769 +769 @@
 \item Changed return types of \code{psXMLDocToFile, psXMLDocToMem,
   psXMLDocToFD} to bool (bug 499).
-\end{itemize}
-
+\item Clarified behaviour of \code{psLogSetDestination} and \code{psTraceSetDestination}.
+\end{itemize}
+

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.325 2005-08-16 23:18:38 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.326 2005-08-24 01:38:16 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1234 +1234 @@
 void psTraceSetDestination(int fd);
 \end{prototype}
-If the \code{fd} is 0, then the trace is sent to standard output,
-otherwise it is sent to the specified file descriptor.  A call to
-\code{psTraceSetDestination} automatically closes the file descriptor.
+If the \code{fd} is zero, then tracing is disabled.  Otherwise, the
+trace is sent to the specified file descriptor.  As a convenience, the
+following are defined:
+\begin{datatype}
+enum {
+    PS_TRACE_TO_NONE = 0,                ///< turn off all traces
+    PS_TRACE_TO_STDOUT = 1,              ///< trace to system's stdout
+    PS_TRACE_TO_STDERR = 2,              ///< trace to system's stderr
+};
+\end{datatype}
+%
+This arrangement mirros the file descriptors for standard input,
+output and error.  A call to \code{psTraceSetDestination}
+automatically closes an open file descriptor.
 
 The corresponding function
@@ -1285 +1296 @@
 
 Specifying a \code{format} of \code{NULL} turns off logging (equivalent
-to calling \code{psLogSetDestination(PS_LOG_TO_NONE)}, whereas if the
+to calling \code{psTraceSetDestination(PS_TRACE_TO_NONE)}, whereas if the
 \code{format} is \code{""}, then the format reverts to the default.
 
@@ -1352 +1363 @@
 \end{prototype}
 %
-If the \code{fd} is 0, then the log is sent to standard output,
-otherwise it is sent to the specified file descriptor.  A call to
-\code{psLogSetDestination} automatically closes an open file
-descriptor.
+If the \code{fd} is zero, then logging is disabled.  Otherwise, the
+log is sent to the specified file descriptor.  As a convenience, the
+following are defined:
+\begin{datatype}
+enum {
+    PS_LOG_TO_NONE = 0,                  ///< turn off logging
+    PS_LOG_TO_STDOUT = 1,                ///< log to system's stdout
+    PS_LOG_TO_STDERR = 2,                ///< log to system's stderr
+};
+\end{datatype}
+%
+This arrangement mirros the file descriptors for standard input,
+output and error.  A call to \code{psLogSetDestination} automatically
+closes an open file descriptor.
 
 The corresponding function