From 3e6d86b2d5eabfe012100e6fc43ae9c3aa2fd6a4 Mon Sep 17 00:00:00 2001 From: Ross Owen Date: Mon, 14 Oct 2024 16:29:02 +0100 Subject: [PATCH 1/2] Parameterise infr_apps version --- .../application-note-not-compliant.md | 17 ------ .../ISSUE_TEMPLATE/example-not-compliant.md | 18 ------- .../missing-application-note.md | 10 ---- .github/ISSUE_TEMPLATE/missing-c-api.md | 10 ---- .github/ISSUE_TEMPLATE/missing-xcore-test.md | 10 ---- .github/ISSUE_TEMPLATE/test-not-compliant.md | 16 ------ .../top-level-readme-not-compliant.md | 13 ----- .gitignore | 54 +++++++++++++------ Jenkinsfile | 7 ++- 9 files changed, 43 insertions(+), 112 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/application-note-not-compliant.md delete mode 100644 .github/ISSUE_TEMPLATE/example-not-compliant.md delete mode 100644 .github/ISSUE_TEMPLATE/missing-application-note.md delete mode 100644 .github/ISSUE_TEMPLATE/missing-c-api.md delete mode 100644 .github/ISSUE_TEMPLATE/missing-xcore-test.md delete mode 100644 .github/ISSUE_TEMPLATE/test-not-compliant.md delete mode 100644 .github/ISSUE_TEMPLATE/top-level-readme-not-compliant.md diff --git a/.github/ISSUE_TEMPLATE/application-note-not-compliant.md b/.github/ISSUE_TEMPLATE/application-note-not-compliant.md deleted file mode 100644 index 90723cb..0000000 --- a/.github/ISSUE_TEMPLATE/application-note-not-compliant.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Application Note Issue -about: Template for an Application note issue report -title: examples/ANXXXXX Application Note not compliant -labels: documentation -assignees: '' - ---- - - - - -**Issues:** - - - xdoc-custom RST directives used in the Application Note README - - application note code not compiling for xcore-ai - - application note code not running successfully on xcore-ai diff --git a/.github/ISSUE_TEMPLATE/example-not-compliant.md b/.github/ISSUE_TEMPLATE/example-not-compliant.md deleted file mode 100644 index 5e68cdb..0000000 --- a/.github/ISSUE_TEMPLATE/example-not-compliant.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Example Issue -about: Template for an example issue report -title: examples/xxx Example not compliant -labels: documentation -assignees: '' - ---- - - - - -**Issues:** - - - convert example to Application Note - - xdoc-custom RST directives used in the README - - example code not compiling for xcore-ai - - example code not running successfully on xcore-ai diff --git a/.github/ISSUE_TEMPLATE/missing-application-note.md b/.github/ISSUE_TEMPLATE/missing-application-note.md deleted file mode 100644 index 9404dde..0000000 --- a/.github/ISSUE_TEMPLATE/missing-application-note.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Missing Application Note -about: Template for a Missing Application Note issue report -title: Missing Application Note -labels: documentation -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/missing-c-api.md b/.github/ISSUE_TEMPLATE/missing-c-api.md deleted file mode 100644 index 6230ef7..0000000 --- a/.github/ISSUE_TEMPLATE/missing-c-api.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Missing C API Issue -about: Template for a Missing C API issue report -title: Missing C API -labels: enhancement -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/missing-xcore-test.md b/.github/ISSUE_TEMPLATE/missing-xcore-test.md deleted file mode 100644 index 866e97c..0000000 --- a/.github/ISSUE_TEMPLATE/missing-xcore-test.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Missing xCore Test Issue -about: Template for a Missing xCore test issue report -title: Missing xCore test -labels: testing -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/test-not-compliant.md b/.github/ISSUE_TEMPLATE/test-not-compliant.md deleted file mode 100644 index cce3e91..0000000 --- a/.github/ISSUE_TEMPLATE/test-not-compliant.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Test Issue -about: Template for a Test issue report -title: tests/XXX does not build or fails -labels: testing -assignees: '' - ---- - - - - -**Issues:** - - - Test not compiling for xcore-ai - - Test not running successfully on xcore-ai diff --git a/.github/ISSUE_TEMPLATE/top-level-readme-not-compliant.md b/.github/ISSUE_TEMPLATE/top-level-readme-not-compliant.md deleted file mode 100644 index 931414c..0000000 --- a/.github/ISSUE_TEMPLATE/top-level-readme-not-compliant.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Top-level README Issue -about: Template for the top-level README issue report -title: Top-level README not compliant -labels: documentation -assignees: '' - ---- - - -**Issues:** - - - xdoc-custom RST directives used in the README diff --git a/.gitignore b/.gitignore index ab417e1..06ab964 100644 --- 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/Jenkinsfile b/Jenkinsfile index bc287ae..01137c9 100644 --- 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}") } } } From 85eec003ebb09fcf8c1f0c4c23799f26aca487e9 Mon Sep 17 00:00:00 2001 From: Ross Owen Date: Mon, 14 Oct 2024 16:48:40 +0100 Subject: [PATCH 2/2] Documentation tweaks and sub-minor version bump --- CHANGELOG.rst | 5 +++++ doc/rst/{logging.rst => lib_logging.rst} | 7 +++++-- lib_logging/lib_build_info.cmake | 2 +- lib_logging/module_build_info | 2 +- settings.yml | 6 +++--- 5 files changed, 15 insertions(+), 7 deletions(-) rename doc/rst/{logging.rst => lib_logging.rst} (89%) 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: