Changeset 4180 for trunk/psLib/src/sysUtils/psLogMsg.c

Timestamp:

Jun 8, 2005, 8:12:31 PM (21 years ago)

Author:

gusciora

Message:

...

File:

• trunk/psLib/src/sysUtils/psLogMsg.c (modified) (12 diffs)

trunk/psLib/src/sysUtils/psLogMsg.c

@@ -3 +3 @@
  *  \ingroup LogTrace
  *
- *  This file will hold the prototypes for defining procedure which set
- *  message log levels, messahe log formats, message log destinations, and
- *  for generating the messages themselves.
+ *  This file contains code for setting message log levels, message log
+ *  formats, message log destinations, and for generating the messages
+ *  themselves.
  *  @ingroup LogTrace
  *
  *  @author Robert Lupton, Princeton University
- *  @author George Gusciora, MHPCC
+ *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.40 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-08 23:40:45 $
+ *  @version $Revision: 1.41 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-09 06:12:31 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -61 +61 @@
  level (psS32): the new log level.
 Output:
- none
-Return:
  The old log level.
  *****************************************************************************/
@@ -82 +80 @@
 
 /*****************************************************************************
-psLogSetDestination(): sets the destination where log messages will be
-sent to.
- 
+psLogSetDestination(): sets the log message destination.
 Input:
  dest (psS32): the new log destination
-Output:
- None.
 Return:
- An integer specifying the old log destination.
+ An psBool: TRUE if successful.
  *****************************************************************************/
 psBool psLogSetDestination(const char *dest)
@@ -132 +126 @@
             return true;
         }
-        psError(PS_ERR_LOCATION_INVALID, true,
-                PS_ERRORTEXT_psLogMsg_DEST_LOCATION_INVALID,
+        psError(PS_ERR_LOCATION_INVALID, true, PS_ERRORTEXT_psLogMsg_DEST_LOCATION_INVALID,
                 location);
         return 1;
@@ -140 +133 @@
 
         if (file == NULL) {
-            psError(PS_ERR_IO, true,
-                    PS_ERRORTEXT_psLogMsg_OPEN_FILE_FAILED,
+            psError(PS_ERR_IO, true, PS_ERRORTEXT_psLogMsg_OPEN_FILE_FAILED,
                     location);
             return false;
@@ -152 +144 @@
     }
 
-    psError(PS_ERR_LOCATION_INVALID, true,
-            PS_ERRORTEXT_psLogMsg_UNSUPPORTED_PROTOCOL,
+    psError(PS_ERR_LOCATION_INVALID, true, PS_ERRORTEXT_psLogMsg_UNSUPPORTED_PROTOCOL,
             protocol);
     return false;
@@ -168 +159 @@
 Input:
     fmt: a string specifying the format.
-Output:
-    none.
 Return:
     NULL.
@@ -175 +164 @@
 void psLogSetFormat(const char *fmt)
 {
-    // assume nothing desired unless specified
+    // assume none.
     logHost = false;
     logLevel = false;
@@ -187 +176 @@
     }
 
+    // XXX: What is the purpose of this conditional.
     if (strlen(fmt) == 0) {
         fmt = "THLNM";
     }
     // Step through each character in the format string.  For each letter
-    // in that string, set/unset the appropriate logging.
+    // in that string, set the appropriate logging.
 
     for (const char *ptr = fmt; *ptr != '\0'; ptr++) {
@@ -222 +212 @@
     }
 
+    // XXX: If one must at least log error messages, why don't we set logMsg = true here?
     if (!logMsg) {
         psTrace("utils.logMsg", 1, "You must at least log error messages (You chose \"%s\")", fmt);
@@ -232 +223 @@
 
 /*****************************************************************************
-    psVLogMsg(): This routine sends the message, which is a printf style
- string specified in the "..." argument, to the current message log
- destination with the severity specified by the "level" argument.
-    Input:
- name
- level
- fmt
- ap
-    Output:
- none
-    Return:
- NULL.
+psVLogMsg(): This routine sends the message, which is a printf style string
+specified in the "..." argument, to the current message log destination with
+the severity specified by the "level" argument.
+ Input:
+   name
+   level
+   fmt
+   ap
  *****************************************************************************/
 void psLogMsgV(const char *name, psS32 level, const char *fmt, va_list ap)
@@ -361 +348 @@
 
 /*****************************************************************************
-    psLogMsg(): This routine sends the message, which is a printf style
- string specified in the "..." argument, to the current message log
- destination with the severity specified by the "level" argument.
-    Input:
- name: Indicates the source of this log message.
- level: The severity of this log message.
- fmt: The printf-stype formatted string, followed by the arguments
-  to that string.
- ... The arguments to the above printf-style string.
-    Output:
- none
-    Return:
- NULL
+psLogMsg(): This routine sends the message, which is a printf style string
+specified in the "..." argument, to the current message log destination with
+the severity specified by the "level" argument.
+ 
+Input:
+  name: Indicates the source of this log message.
+  level: The severity of this log message.
+  fmt: The printf-stype formatted string, followed by the arguments
+        to that string.
+  ... The arguments to the above printf-style string.
+ 
+Return:
+   NULL
  *****************************************************************************/
 void psLogMsg(const char *name, psS32 level, const char *fmt, ...)