Changeset 4260

Timestamp:

Jun 14, 2005, 3:11:17 PM (21 years ago)

Author:

jhoblitt

Message:

no longer abv. format as fmt

Location:

trunk/doc/pslib

Files:

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

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.144 2005-06-15 01:08:13 jhoblitt Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.145 2005-06-15 01:11:17 jhoblitt Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -642 +642 @@
   \item rename functions/datatypes to abv. ``memory'' as ``mem''
   \item rename functions/datatypes to abv. ``function'' as ``func'' (not ``fcn'')
+  \item no longer abv. ``format'' as ``fmt''
   \item remove ``my'' from function parameters names
   \item add \code{psComparePtrFunc} function pointer

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.286 2005-06-15 01:08:13 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.287 2005-06-15 01:11:17 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1094 +1094 @@
 %
 \begin{prototype}
-void psTrace(const char *facil, int level, const char *fmt,...);
-void psTraceV(const char *facil, int level, const char *fmt, va_list ap);
+void psTrace(const char *facil, int level, const char *format,...);
+void psTraceV(const char *facil, int level, const char *format, va_list ap);
 \end{prototype}
 % 
-where the \code{fmt} argument is a printf-style formatting code
+where the \code{format} argument is a printf-style formatting code
 followed by possible arguments to that formatting statement, to be
 implemented using the \code{vprintf} functions.  This command
@@ -1215 +1215 @@
 %
 \begin{prototype}
-bool psTraceSetFormat(const char *fmt);
+bool psTraceSetFormat(const char *format);
 \end{prototype}
 %
@@ -1252 +1252 @@
 removes those entries from the output messages.
 
-Specifying a \code{fmt} of \code{NULL} turns off logging (equivalent
+Specifying a \code{format} of \code{NULL} turns off logging (equivalent
 to calling \code{psLogSetDestination(PS_LOG_TO_NONE)}, whereas if the
-\code{fmt} is \code{""}, then the format reverts to the default.
+\code{format} is \code{""}, then the format reverts to the default.
 
 \subsubsection{Message Logging}
@@ -1277 +1277 @@
 %
 \begin{prototype}
-void psLogMsg(const char *name, int level, const char *fmt, ...); 
-void psLogMsgV(const char *name, int level, const char *fmt, va_list ap); 
+void psLogMsg(const char *name, int level, const char *format, ...); 
+void psLogMsgV(const char *name, int level, const char *format, va_list ap); 
 \end{prototype}
 where \code{name} is a word to describe the source of the message,
-\code{level} is the severity level of this message, and \code{fmt}
+\code{level} is the severity level of this message, and \code{format}
 is a printf-style formatting statement defining the actual message,
 and is followed by the arguments to the formatting code.  The second
@@ -1330 +1330 @@
 %
 \begin{prototype}
-bool psLogSetFormat(const char *fmt);
+bool psLogSetFormat(const char *format);
 \end{prototype}
 %
@@ -1367 +1367 @@
 removes those entries from the output messages.
 
-Specifying a \code{fmt} of \code{NULL} turns off logging (equivalent
+Specifying a \code{format} of \code{NULL} turns off logging (equivalent
 to calling \code{psLogSetDestination(PS_LOG_TO_NONE)}, whereas if the
-\code{fmt} is \code{""}, then the format reverts to the default.
+\code{format} is \code{""}, then the format reverts to the default.
 
 The following utility opens an output file descriptor for use by the
@@ -1401 +1401 @@
 \begin{prototype}
 psErrorCode p_psError(const char *filename, unsigned int lineno, const char *func, psErrorCode code,
-                      bool new, const char *fmt, ...);
-\end{prototype}
-\begin{datatype}
-#define psError(code, new, fmt, ...) psError(__FILE__, __LINE__, __func__, code, new, fmt, __VA_ARGS__)
+                      bool new, const char *format, ...);
+\end{prototype}
+\begin{datatype}
+#define psError(code, new, format, ...) psError(__FILE__, __LINE__, __func__, code, new, format, __VA_ARGS__)
 \end{datatype}
 
@@ -1416 +1416 @@
 specifies that an error was passed to this location.  Raising new
 error should clear the error stack.  The final required argument,
-\code{fmt}, is a \code{printf}-style format that is passed to
+\code{format}, is a \code{printf}-style format that is passed to
 \code{psLogMsgV} with code \code{PS_LOG_ERROR}, and component equal to
 the concatenation of the file name and the line number, separated by a
@@ -1450 +1450 @@
 descriptor by calling \code{psErrorStackPrint} (or
 \code{psErrorStackPrintV}); if and only if there are current errors,
-the printf-style string \code{fmt} is first printed to the file
+the printf-style string \code{format} is first printed to the file
 descriptor \code{fd}. In this printout, error codes shall be replaced
 by their string equivalents as defined in the next section.  Note that
@@ -1458 +1458 @@
 %
 \begin{prototype}
-void psErrorStackPrint(FILE *fd, const char *fmt, ...);
-void psErrorStackPrintV(FILE *fd, const char *fmt, va_list va);
+void psErrorStackPrint(FILE *fd, const char *format, ...);
+void psErrorStackPrintV(FILE *fd, const char *format, va_list va);
 \end{prototype}
 
@@ -1568 +1568 @@
 
 \begin{prototype}
-void psAbort(const char *name, const char *fmt,...);
+void psAbort(const char *name, const char *format, ...);
 \end{prototype}