Index: /trunk/psLib/src/sys/psLogMsg.c =================================================================== --- /trunk/psLib/src/sys/psLogMsg.c (revision 4179) +++ /trunk/psLib/src/sys/psLogMsg.c (revision 4180) @@ -3,14 +3,14 @@ * \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,6 +61,4 @@ level (psS32): the new log level. Output: - none -Return: The old log level. *****************************************************************************/ @@ -82,13 +80,9 @@ /***************************************************************************** -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,6 +126,5 @@ 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,6 +133,5 @@ 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,6 +144,5 @@ } - 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,6 +159,4 @@ Input: fmt: a string specifying the format. -Output: - none. Return: NULL. @@ -175,5 +164,5 @@ void psLogSetFormat(const char *fmt) { - // assume nothing desired unless specified + // assume none. logHost = false; logLevel = false; @@ -187,9 +176,10 @@ } + // 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,4 +212,5 @@ } + // 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,16 +223,12 @@ /***************************************************************************** - 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,17 +348,17 @@ /***************************************************************************** - 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, ...) Index: /trunk/psLib/src/sys/psLogMsg.h =================================================================== --- /trunk/psLib/src/sys/psLogMsg.h (revision 4179) +++ /trunk/psLib/src/sys/psLogMsg.h (revision 4180) @@ -9,8 +9,8 @@ * * @author Robert Lupton, Princeton University - * @author George Gusciora, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.23 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.24 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-09 06:12:31 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -26,9 +26,7 @@ */ -/** This procedure sets the destination for future log messages. Currently - * the destination is specified by an integer which can have the following - * pre-defined values: PS_LOG_NONE, PS_LOG_TO_STDOUT, and PS_LOG_TO_STDERR. - * In future versions, this procedure will take a character string as an - * argument which can specify more general log destinations. +/** This procedure sets the destination for future log messages. + * This procedure will take a character string as an + * argument which can specify general log destinations. * * @return psS32 true if set successfully, otherwise false. @@ -42,5 +40,5 @@ * "mylevel" is less than the current log level set by this procedure. * Ie. higher values set by this procedure will cause more log messages to - * be displayed. + * be displayed. The old log level will be returned. * * @return psS32 old logging level @@ -54,6 +52,6 @@ * (level), M (message), N (name), and T (time). The default is "THLNM". * Deleting a letter from the string will cause the associated information - * to not be logged. - * + * to not be logged. This procedure does not alter the order in which + * the messages are displayed. */ void psLogSetFormat( @@ -64,5 +62,5 @@ * call to psLogSetDestination(), if myLevel is less than the level * specified by a prior call to psLogSetLevel(). The message is specified - * with a printf-stype string an arguments. + * with a printf-type string and arguments. * */ Index: /trunk/psLib/src/sysUtils/psLogMsg.c =================================================================== --- /trunk/psLib/src/sysUtils/psLogMsg.c (revision 4179) +++ /trunk/psLib/src/sysUtils/psLogMsg.c (revision 4180) @@ -3,14 +3,14 @@ * \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,6 +61,4 @@ level (psS32): the new log level. Output: - none -Return: The old log level. *****************************************************************************/ @@ -82,13 +80,9 @@ /***************************************************************************** -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,6 +126,5 @@ 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,6 +133,5 @@ 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,6 +144,5 @@ } - 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,6 +159,4 @@ Input: fmt: a string specifying the format. -Output: - none. Return: NULL. @@ -175,5 +164,5 @@ void psLogSetFormat(const char *fmt) { - // assume nothing desired unless specified + // assume none. logHost = false; logLevel = false; @@ -187,9 +176,10 @@ } + // 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,4 +212,5 @@ } + // 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,16 +223,12 @@ /***************************************************************************** - 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,17 +348,17 @@ /***************************************************************************** - 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, ...)