summaryrefslogtreecommitdiff
path: root/docs/doxygen/other/logger.dox
diff options
context:
space:
mode:
authorMarcus Müller <marcus.mueller@ettus.com>2018-03-30 20:50:04 +0200
committerMarcus Müller <marcus.mueller@ettus.com>2018-03-30 20:50:04 +0200
commit61c0382eb2935a6da6c81bd93c8b9c8ef2893df2 (patch)
tree5e67df4059f5522ccc62cd85f33100ee96bb7988 /docs/doxygen/other/logger.dox
parent9a6bf484394f5954483477856f6a6712331b9ee6 (diff)
parent20d463d138782fd56397f5324be6e34af156b239 (diff)
Merge branch 'maint' through 'last_merge_to_master'
This is the last time we're merging 'maint' to 'master'. The 'maint' branch will cease to exist shortly; we'll have a 'maint-3.7' branch. For further information on the new development model: http://lists.gnu.org/archive/html/discuss-gnuradio/2018-02/msg00133.html
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