summaryrefslogtreecommitdiff
path: root/docs/doxygen/other/logger.dox
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-06-07 19:17:08 -0400
committerTom Rondeau <trondeau@vt.edu>2013-06-13 15:27:26 -0400
commitab08c7f7f5e72c10ce934ea6cb6ef2e1ebe01ce5 (patch)
tree8e65f79c1882d2af18a5322bf2afb2efb3576354 /docs/doxygen/other/logger.dox
parent47ab3e90cd9d2a5a1932e56f10c794724ad0ce1d (diff)
docs: typos fixed.
Diffstat (limited to 'docs/doxygen/other/logger.dox')
-rw-r--r--docs/doxygen/other/logger.dox36
1 files changed, 18 insertions, 18 deletions
diff --git a/docs/doxygen/other/logger.dox b/docs/doxygen/other/logger.dox
index 3eb487d9af..c235bfe6f8 100644
--- a/docs/doxygen/other/logger.dox
+++ b/docs/doxygen/other/logger.dox
@@ -83,7 +83,7 @@ data members of d_logger and d_debug_logger of gr_block and pass them
to our pre-defined macros:
\code
- gr::LOG_<level>(<logger>, "<Message to print>");
+ GR_LOG_<level>(<logger>, "<Message to print>");
\endcode
Where \<level\> is one of the levels as mentioned above, \<logger\> is
@@ -93,8 +93,8 @@ message to the standard logger and a WARN level message to the debug
logger, it would look like this:
\code
- gr::LOG_INFO(d_logger, "Some info about the block");
- gr::LOG_WARN(d_debug_logger, "Some warning about the block");
+ GR_LOG_INFO(d_logger, "Some info about the block");
+ GR_LOG_WARN(d_debug_logger, "Some warning about the block");
\endcode
When this is printed to wherever you are directing the output of the
@@ -115,15 +115,15 @@ The various logging macros are defined in gr_logger.h. Here are some
simple examples of using them:
\code
- gr::LOG_DEBUG(LOG, "DEBUG message");
- gr::LOG_INFO(LOG, "INFO message");
- gr::LOG_NOTICE(LOG, "NOTICE message");
- gr::LOG_WARN(LOG, "WARNING message");
- gr::LOG_ERROR(LOG, "ERROR message");
- gr::LOG_CRIT(LOG, "CRIT message");
- gr::LOG_ALERT(LOG, "ALERT message");
- gr::LOG_FATAL(LOG, "FATAL message");
- gr::LOG_EMERG(LOG, "EMERG message");
+ GR_LOG_DEBUG(LOG, "DEBUG message");
+ GR_LOG_INFO(LOG, "INFO message");
+ GR_LOG_NOTICE(LOG, "NOTICE message");
+ GR_LOG_WARN(LOG, "WARNING message");
+ GR_LOG_ERROR(LOG, "ERROR message");
+ GR_LOG_CRIT(LOG, "CRIT message");
+ GR_LOG_ALERT(LOG, "ALERT message");
+ GR_LOG_FATAL(LOG, "FATAL message");
+ GR_LOG_EMERG(LOG, "EMERG message");
\endcode
If the logger is not enabled, then these macros become nops and do
@@ -188,20 +188,20 @@ a singleton in the system, but we need to get a pointer to the right
logger and then set it up for our local use. The following code
snippet shows how to do this to get access to the standard logger,
which has a root of "gr_log." (access to the debug logger is similar
-except we would use "gr_log_debug." in the gr::LOG_GETLOGGER call):
+except we would use "gr_log_debug." in the GR_LOG_GETLOGGER call):
\code
prefs *p = prefs::singleton();
std::string log_file = p->get_string("LOG", "log_config", "");
std::string log_level = p->get_string("LOG", "log_level", "off");
- gr::CONFIG_LOGGER(log_file);
- gr::LOG_GETLOGGER(LOG, "gr_log." + "my_logger_name");
- gr::LOG_SET_LEVEL(LOG, log_level);
+ GR_CONFIG_LOGGER(log_file);
+ GR_LOG_GETLOGGER(LOG, "gr_log." + "my_logger_name");
+ GR_LOG_SET_LEVEL(LOG, log_level);
\endcode
This creates a pointer called LOG (which is instantiated as a
log4cpp:LoggerPtr in the macro) that we can now use locally as the
-input to our logging macros like 'gr::LOG_INFO(LOG, "message")'.
+input to our logging macros like 'GR_LOG_INFO(LOG, "message")'.
\section logPy Logging from Python
@@ -215,7 +215,7 @@ of the logger can be manipulated via the following calls:
\endcode
Once the logger is configured you can manipulate a logger via a wrapper class gr.logger().
-You can isntantiate this by the following. (Reference gr_logger.h for list of methods)
+You can isntantiate this by the following. (Reference logger.h for list of methods)
\code
from gnuradio import gr
log=gr.logger("nameOfLogger")