diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 284f5b2..b317f10 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,11 @@ lib_logging change log ====================== +3.3.1 +----- + + * CHANGED: Documentation updates + 3.3.0 ----- diff --git a/doc/rst/logging.rst b/doc/rst/lib_logging.rst similarity index 89% rename from doc/rst/logging.rst rename to doc/rst/lib_logging.rst index ad8d62f..b790e0a 100644 --- a/doc/rst/logging.rst +++ b/doc/rst/lib_logging.rst @@ -11,6 +11,9 @@ or disabled via configuration defines. Code can be declared to be within a "debug unit" (usually a library or application source base) and prints can be enabled/disabled per debug unit. +``lib_logging`` is intended to be used with the `XCommon CMake `_ +, the `XMOS` application build and dependency management system. + *** API *** @@ -21,7 +24,7 @@ To use this module, include ``lib_logging`` in the application's .. doxygenfunction:: debug_printf *********** -Debug Units +Debug units *********** A source file can be added to a debug unit by defining the ``DEBUG_UNIT`` macro before inclusion of ``debug_print.h``. For example:: @@ -37,7 +40,7 @@ convenient to do it in the ``lib_build_info.cmake`` file of the module e.g.:: If no ``DEBUG_UNIT`` is defined then the default debug unit is ``APPLICATION``. ***************** -Enabling Printing +Enabling printing ***************** By default, debug printing is turned *off*. To enable printing you diff --git a/lib_logging/lib_build_info.cmake b/lib_logging/lib_build_info.cmake index 01365b1..8540afd 100644 --- a/lib_logging/lib_build_info.cmake +++ b/lib_logging/lib_build_info.cmake @@ -1,5 +1,5 @@ set(LIB_NAME lib_logging) -set(LIB_VERSION 3.3.0) +set(LIB_VERSION 3.3.1) set(LIB_INCLUDES api) set(LIB_COMPILER_FLAGS -Os) set(LIB_DEPENDENT_MODULES "") diff --git a/lib_logging/module_build_info b/lib_logging/module_build_info index 05ac40c..98400b2 100644 --- a/lib_logging/module_build_info +++ b/lib_logging/module_build_info @@ -1,4 +1,4 @@ -VERSION = 3.3.0 +VERSION = 3.3.1 DEPENDENT_MODULES = diff --git a/settings.yml b/settings.yml index 7576ab3..7162c6d 100644 --- a/settings.yml +++ b/settings.yml @@ -2,18 +2,18 @@ lib_name: lib_logging project: '{{lib_name}}' title: '{{lib_name}}: Debug Printing' -version: 3.3.0 +version: 3.3.1 documentation: exclude_patterns_path: doc/exclude_patterns.inc - root_doc: doc/rst/logging.rst + root_doc: doc/rst/lib_logging.rst linkcheck_ignore_regex: [''] cognidox_part_number: XM-006383-UG doxygen_projects: lib_logging: doxyfile_path: doc/Doxyfile.inc pdfs: - doc/rst/logging.rst: + doc/rst/lib_logging.rst: pdf_title: '{{title}}' pdf_filename: '{{lib_name}}_v{{version}}' README.rst: