Merge pull request #78 from xross/develop

Parameterise infr_apps version
xmos · Oct 14, 2024 · b8e939c · b8e939c
2 parents 45bf957 + 85eec00
commit b8e939c
Show file tree

Hide file tree

Showing 15 changed files with 59 additions and 120 deletions.
diff --git a/.github/ISSUE_TEMPLATE/application-note-not-compliant.md b/.github/ISSUE_TEMPLATE/application-note-not-compliant.md
diff --git a/.github/ISSUE_TEMPLATE/example-not-compliant.md b/.github/ISSUE_TEMPLATE/example-not-compliant.md
diff --git a/.github/ISSUE_TEMPLATE/missing-application-note.md b/.github/ISSUE_TEMPLATE/missing-application-note.md
diff --git a/.github/ISSUE_TEMPLATE/missing-c-api.md b/.github/ISSUE_TEMPLATE/missing-c-api.md
diff --git a/.github/ISSUE_TEMPLATE/missing-xcore-test.md b/.github/ISSUE_TEMPLATE/missing-xcore-test.md
diff --git a/.github/ISSUE_TEMPLATE/test-not-compliant.md b/.github/ISSUE_TEMPLATE/test-not-compliant.md
diff --git a/.github/ISSUE_TEMPLATE/top-level-readme-not-compliant.md b/.github/ISSUE_TEMPLATE/top-level-readme-not-compliant.md
diff --git a/.gitignore b/.gitignore
@@ -1,22 +1,42 @@
-**/.build*/*
-**/bin/*
-*.o
-*.xe
+# Tmp files & logs
+*.settings
+*.bin
+*.zip
+*.log
 *.vcd
-*.s
+*.swp
+*.*~
+*.xmt
+*.swo
+*.swn
+*~
+*.DS_Store
+
+# Python
+*.pyc
+**/*.egg-info/
+**/.venv*/
+
+# XMOS temp files
+**/*build*/*
+*/bin/*
+**/flash_bin_node*
+**/fw-*
+**/s2l-*
+**/spanning-xn-*
+**/target-xn*
 *.xi
+*.o
 *.i
 *.a
-**/_build/
-**/run_*.log
-**/pdf/*
-**/html/*
-**/.settings/*
-*.pyc
-**/test_results.csv
-**/.venv/**
+*.d
+*.decouple
+*.pca.xml
+**/CMakeFiles/*
+
+# XMOS binaries
+*.xe
 
-# waf build files
-.lock-waf_*
-.waf-*/
-build/
+# Built documentation
+doc/_build/pdf/*.pdf
+**/doc/pdf/*.pdf
diff --git 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/Jenkinsfile b/Jenkinsfile
@@ -25,6 +25,11 @@ pipeline {
       defaultValue: 'v6.1.2',
       description: 'The xmosdoc version'
     )
+    string(
+      name: 'INFR_APPS_VERSION',
+      defaultValue: 'v2.0.1',
+      description: 'The infr_apps version'
+    )
   }
   stages {
     stage('Build') {
@@ -49,7 +54,7 @@ pipeline {
                 buildDocs()
               }
             }
-            runLibraryChecks("${WORKSPACE}/${REPO}", "v2.0.1")
+            runLibraryChecks("${WORKSPACE}/${REPO}", "${params.INFR_APPS_VERSION}")
           }
         }
       }

diff --git a/README.rst b/README.rst
@@ -5,7 +5,7 @@ lib_logging: Debug Printing
 ###########################
 
 :vendor: XMOS
-:version: 3.3.0
+:version: 3.3.1
 :scope: General Use
 :description: Debug printing
 :category: General Purpose

diff --git a/doc/rst/logging.rst → doc/rst/lib_logging.rst b/doc/rst/logging.rst → 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 <https://www.xmos.com/file/xcommon-cmake-documentation/?version=latest>`_
+, 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
@@ -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
@@ -1,4 +1,4 @@
-VERSION = 3.3.0
+VERSION = 3.3.1
 
 DEPENDENT_MODULES =
 

diff --git 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: