summaryrefslogtreecommitdiff
path: root/docs/doxygen/other/logger.dox
diff options
context:
space:
mode:
authorJacob Gilbert <mrjacobagilbert@gmail.com>2018-02-14 19:05:41 -0800
committerMarcus Müller <marcus.mueller@ettus.com>2018-03-30 16:50:32 +0200
commit2a5c8804218eb3f8223a5152a1e4c96e6bc01097 (patch)
treec25c6102a156d857f09a847c1e0d047a340710e9 /docs/doxygen/other/logger.dox
parente6adaad90462fbc03663cc81d2be3a39f35dc8cb (diff)
logging: updated doxygen with section about how to use logging module in OOT modules
Diffstat (limited to 'docs/doxygen/other/logger.dox')
-rw-r--r--docs/doxygen/other/logger.dox18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/doxygen/other/logger.dox b/docs/doxygen/other/logger.dox
index ae6a744d00..c8e4a5daa2 100644
--- a/docs/doxygen/other/logger.dox
+++ b/docs/doxygen/other/logger.dox
@@ -212,6 +212,24 @@ 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")'.
+\subsection using_logging Using Logging in Out of Tree Modules
+
+In order to use the logging interface in an out of tree module based on a
+gr_modtool template module, several CMake modifications are required.
+Without these changes, logging will be disabled.
+
+GrMiscUtils.cmake module must be included in the OOT module top level
+CMakeLists.Texts file, and the GR_LOGGING() function provided by GrMiscUtils
+must be called from the same top level CMakeLists.txt file. This will
+set the appropriate build environment and during that process, attempt
+to find the log4cpp package using the FindLog4Cpp.cmake module.
+This module is not included in the module by gr_modtool, but is part of
+the GNU Radio codebase and can be copied directly into the cmake/Modules/
+directory of the OOT module.
+
+Once these CMake changes are made, the GR logging interface will function
+as documented on this page.
+
\section logPy Logging from Python
The logging capability has been brought out python via swig. The configuration