From 18c5463849c768d13a9846870edc390ce90760c4 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 19:14:13 +0200 Subject: [PATCH 01/10] doc: zephyr: fix typo in ZEPHYR_BUILD log message Rather than the content of ZEPHYR_BUILD, the content of ZEPHYR_BASE was emitted once again. Signed-off-by: Stephan Linz --- doc/zephyr/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/zephyr/conf.py b/doc/zephyr/conf.py index 402c61c7d7..d903038848 100644 --- a/doc/zephyr/conf.py +++ b/doc/zephyr/conf.py @@ -93,7 +93,7 @@ logcfg.info('Build with tags: ' + ':'.join(map(str, tags)), color='red') logcfg.info('BRIDLE_BASE is: "{}"'.format(BRIDLE_BASE), color='green') logcfg.info('ZEPHYR_BASE is: "{}"'.format(ZEPHYR_BASE), color='green') -logcfg.info('ZEPHYR_BUILD is: "{}"'.format(ZEPHYR_BASE), color='yellow') +logcfg.info('ZEPHYR_BUILD is: "{}"'.format(ZEPHYR_BUILD), color='yellow') logcfg.info('BRIDLE_ZEPHYR_BUILD is: "{}"'.format(BRIDLE_ZEPHYR_BUILD), color='yellow') From f63d4dd5fac3313f0a3a75edc5f08c6ef644b35f Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 19:20:08 +0200 Subject: [PATCH 02/10] doc: doxygen: move warning log file to safe place For post-mortem investigations, the Doxygen log file with all warnings is now placed inside the documentation working directory. Signed-off-by: Stephan Linz --- doc/CMakeLists.txt | 2 ++ doc/_doxygen/doxyfile-bridle.in | 2 +- doc/_doxygen/doxyfile-zephyr.in | 2 +- doc/bridle/conf.py | 4 ++++ doc/zephyr/conf.py | 11 ++++++----- 5 files changed, 14 insertions(+), 7 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index a5a108e495..c124de1a0c 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -238,6 +238,8 @@ function(add_docset name sphinxopts) -DDOXY_OUT="${DOCSET_DOXY_DIR}" -DDOXY_IN="${SHARED_DOXYGEN_DIR}" -DDOXY_LAYOUT="standalone" + -DDOXY_LOGOUT="${DOCSET_DOXY_DIR}" + -DDOXY_LOGWRN="warnings.txt" -DPROJECT_DOXY="${PROJECT_DOXYGEN_DIR}" -DPROJECT_BASE=${DOCSET_BASE} -DPROJECT_NAME="${DOCSET_NAME}" diff --git a/doc/_doxygen/doxyfile-bridle.in b/doc/_doxygen/doxyfile-bridle.in index 55c468c734..3caf050963 100644 --- a/doc/_doxygen/doxyfile-bridle.in +++ b/doc/_doxygen/doxyfile-bridle.in @@ -863,7 +863,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = "@DOXY_OUT@/warnings.txt" +WARN_LOGFILE = "@DOXY_LOGOUT@/@DOXY_LOGWRN@" #--------------------------------------------------------------------------- # Configuration options related to the input files diff --git a/doc/_doxygen/doxyfile-zephyr.in b/doc/_doxygen/doxyfile-zephyr.in index 13c3083ee8..6d7d0193aa 100644 --- a/doc/_doxygen/doxyfile-zephyr.in +++ b/doc/_doxygen/doxyfile-zephyr.in @@ -863,7 +863,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = "@DOXY_OUT@/warnings.txt" +WARN_LOGFILE = "@DOXY_LOGOUT@/@DOXY_LOGWRN@" #--------------------------------------------------------------------------- # Configuration options related to the input files diff --git a/doc/bridle/conf.py b/doc/bridle/conf.py index 53336142c4..588c64ee01 100644 --- a/doc/bridle/conf.py +++ b/doc/bridle/conf.py @@ -27,6 +27,7 @@ import utils ZEPHYR_BASE = utils.get_projdir('zephyr') +BRIDLE_WORKD = os.path.join(utils.get_builddir(), 'bridle') # Add the '_extensions' directory to sys.path, to enable finding Bridle's # Sphinx extensions within. @@ -78,6 +79,7 @@ logcfg.info(project + ' ' + release, color='yellow') logcfg.info('Build with tags: ' + ':'.join(map(str, tags)), color='red') logcfg.info('BRIDLE_BASE is: "{}"'.format(BRIDLE_BASE), color='green') +logcfg.info('BRIDLE_WORKD is: "{}"'.format(BRIDLE_WORKD), color='yellow') logcfg.info('BRIDLE_BUILD is: "{}"'.format(BRIDLE_BUILD), color='yellow') logcfg.info('ZEPHYR_BASE is: "{}"'.format(ZEPHYR_BASE), color='green') @@ -241,6 +243,8 @@ 'DOXY_SET': u'bridle', 'DOXY_IN': str(Path(doxyrunner_doxyfile).absolute().parent), 'DOXY_LAYOUT': u'zephyr-doxyrunner', + 'DOXY_LOGOUT': str(Path(BRIDLE_WORKD).absolute()), + 'DOXY_LOGWRN': u'doxygen-warnings.txt', 'PROJECT_DOXY': str(Path(doxyrunner_doxydir).absolute()), 'PROJECT_BASE': str(BRIDLE_BASE), 'PROJECT_NAME': project, diff --git a/doc/zephyr/conf.py b/doc/zephyr/conf.py index d903038848..67e7190b3d 100644 --- a/doc/zephyr/conf.py +++ b/doc/zephyr/conf.py @@ -24,7 +24,7 @@ import utils ZEPHYR_BASE = utils.get_projdir('zephyr') -BRIDLE_ZEPHYR_BUILD = os.path.join(utils.get_builddir(), 'zephyr') +ZEPHYR_WORKD = os.path.join(utils.get_builddir(), 'zephyr') # Add the '_extensions' directory to sys.path, to enable finding Bridle's # Sphinx extensions within. @@ -93,9 +93,8 @@ logcfg.info('Build with tags: ' + ':'.join(map(str, tags)), color='red') logcfg.info('BRIDLE_BASE is: "{}"'.format(BRIDLE_BASE), color='green') logcfg.info('ZEPHYR_BASE is: "{}"'.format(ZEPHYR_BASE), color='green') +logcfg.info('ZEPHYR_WORKD is: "{}"'.format(ZEPHYR_WORKD), color='yellow') logcfg.info('ZEPHYR_BUILD is: "{}"'.format(ZEPHYR_BUILD), color='yellow') -logcfg.info('BRIDLE_ZEPHYR_BUILD is: "{}"'.format(BRIDLE_ZEPHYR_BUILD), - color='yellow') # General ---------------------------------------------------------------------- @@ -207,6 +206,8 @@ 'DOXY_SET': u'zephyr', 'DOXY_IN': str(Path(doxyrunner_doxyfile).absolute().parent), 'DOXY_LAYOUT': u'zephyr-doxyrunner', + 'DOXY_LOGOUT': str(Path(ZEPHYR_WORKD).absolute()), + 'DOXY_LOGWRN': u'doxygen-warnings.txt', 'PROJECT_DOXY': str(Path(doxyrunner_doxydir).absolute()), 'PROJECT_BASE': str(ZEPHYR_BASE), 'PROJECT_NAME': project, @@ -222,7 +223,7 @@ # Options for zephyr.warnings_filter ------------------------------------------- -warnings_filter_config = os.path.join(BRIDLE_ZEPHYR_BUILD, 'known-warnings.txt') +warnings_filter_config = os.path.join(ZEPHYR_WORKD, 'known-warnings.txt') warnings_filter_silent = True # -- Options for notfound.extension -------------------------------------------- @@ -264,7 +265,7 @@ def update_inventory_warnings_filter_config(app): if "warnings_filter_config" in app.config: # Update the warnings_filter_config value. app.config.warnings_filter_config = os.path.join( - BRIDLE_ZEPHYR_BUILD, 'known-warnings-inventory.txt' + ZEPHYR_WORKD, 'known-warnings-inventory.txt' ) def update_config(app): From 535c39cf1efa367dd4ddc3b5f35b63295f176fd3 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 19:23:32 +0200 Subject: [PATCH 03/10] doc: doxygen: enable Doxygen autobrief Enable Doxygen AUTOBRIEF feature for both Javadoc and Qt style documentation blocks. This treats the first sentence of a documentation block as a brief description even when no @brief tag is present. This makes the overview sections of the generated documentation much more useful. See https://www.doxygen.nl/manual/config.html#cfg_javadoc_autobrief and https://www.doxygen.nl/manual/config.html#cfg_qt_autobrief Signed-off-by: Stephan Linz --- doc/_doxygen/doxyfile-bridle.in | 4 ++-- doc/_doxygen/doxyfile-zephyr.in | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/_doxygen/doxyfile-bridle.in b/doc/_doxygen/doxyfile-bridle.in index 3caf050963..5293975bb7 100644 --- a/doc/_doxygen/doxyfile-bridle.in +++ b/doc/_doxygen/doxyfile-bridle.in @@ -177,7 +177,7 @@ SHORT_NAMES = NO # description.) # The default value is: NO. -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as @@ -195,7 +195,7 @@ JAVADOC_BANNER = NO # requiring an explicit \brief command for a brief description.) # The default value is: NO. -QT_AUTOBRIEF = NO +QT_AUTOBRIEF = YES # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as diff --git a/doc/_doxygen/doxyfile-zephyr.in b/doc/_doxygen/doxyfile-zephyr.in index 6d7d0193aa..8adf06f5ee 100644 --- a/doc/_doxygen/doxyfile-zephyr.in +++ b/doc/_doxygen/doxyfile-zephyr.in @@ -177,7 +177,7 @@ SHORT_NAMES = NO # description.) # The default value is: NO. -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as @@ -195,7 +195,7 @@ JAVADOC_BANNER = NO # requiring an explicit \brief command for a brief description.) # The default value is: NO. -QT_AUTOBRIEF = NO +QT_AUTOBRIEF = YES # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as From 55a5bb93c91d06b49cddf2dcb9392362e8cf1f47 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 19:25:30 +0200 Subject: [PATCH 04/10] doc: doxygen: cleanup and fix SPI docs build Since Zephyr upstream commit cbc6af0d098f41590af821d672a4c9d23300328d it isn't necessary anymore to pre-define the symbol CONFIG_SPI_ASYNC. See: https://github.com/zephyrproject-rtos/zephyr/commit/cbc6af0 Signed-off-by: Stephan Linz --- doc/_doxygen/doxyfile-bridle.in | 1 - doc/_doxygen/doxyfile-zephyr.in | 1 - 2 files changed, 2 deletions(-) diff --git a/doc/_doxygen/doxyfile-bridle.in b/doc/_doxygen/doxyfile-bridle.in index 5293975bb7..7de58f2063 100644 --- a/doc/_doxygen/doxyfile-bridle.in +++ b/doc/_doxygen/doxyfile-bridle.in @@ -2282,7 +2282,6 @@ PREDEFINED = __DOXYGEN__ \ CONFIG_SCHED_DEADLINE \ CONFIG_SETTINGS_RUNTIME \ CONFIG_SMP \ - CONFIG_SPI_ASYNC \ CONFIG_SYS_CLOCK_EXISTS \ CONFIG_THREAD_CUSTOM_DATA \ CONFIG_THREAD_MONITOR \ diff --git a/doc/_doxygen/doxyfile-zephyr.in b/doc/_doxygen/doxyfile-zephyr.in index 8adf06f5ee..44b75f3445 100644 --- a/doc/_doxygen/doxyfile-zephyr.in +++ b/doc/_doxygen/doxyfile-zephyr.in @@ -2285,7 +2285,6 @@ PREDEFINED = __DOXYGEN__ \ CONFIG_SCHED_DEADLINE \ CONFIG_SETTINGS_RUNTIME \ CONFIG_SMP \ - CONFIG_SPI_ASYNC \ CONFIG_SYS_CLOCK_EXISTS \ CONFIG_THREAD_CUSTOM_DATA \ CONFIG_THREAD_MONITOR \ From ac5237f0d3631e8a0655fd027005633b053ddc39 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 19:31:37 +0200 Subject: [PATCH 05/10] doc: doxygen: improved ieee802154 documentation Sync with Zephyr upstream commit e63969521c3316f6fff35d06eb4514d572d47af5. See: https://github.com/zephyrproject-rtos/zephyr/commit/e639695 Signed-off-by: Stephan Linz --- doc/_doxygen/doxyfile-bridle.in | 2 ++ doc/_doxygen/doxyfile-zephyr.in | 2 ++ 2 files changed, 4 insertions(+) diff --git a/doc/_doxygen/doxyfile-bridle.in b/doc/_doxygen/doxyfile-bridle.in index 7de58f2063..e27a5c616a 100644 --- a/doc/_doxygen/doxyfile-bridle.in +++ b/doc/_doxygen/doxyfile-bridle.in @@ -2273,6 +2273,8 @@ PREDEFINED = __DOXYGEN__ \ CONFIG_HEAP_MEM_POOL_SIZE \ CONFIG_MMU \ CONFIG_NET_L2_ETHERNET_MGMT \ + CONFIG_NET_L2_IEEE802154_MGMT \ + CONFIG_NET_L2_IEEE802154_SECURITY \ CONFIG_NET_MGMT_EVENT \ CONFIG_NET_SOCKETS_POSIX_NAMES \ CONFIG_NET_TCP \ diff --git a/doc/_doxygen/doxyfile-zephyr.in b/doc/_doxygen/doxyfile-zephyr.in index 44b75f3445..8f6494c2cb 100644 --- a/doc/_doxygen/doxyfile-zephyr.in +++ b/doc/_doxygen/doxyfile-zephyr.in @@ -2276,6 +2276,8 @@ PREDEFINED = __DOXYGEN__ \ CONFIG_HEAP_MEM_POOL_SIZE \ CONFIG_MMU \ CONFIG_NET_L2_ETHERNET_MGMT \ + CONFIG_NET_L2_IEEE802154_MGMT \ + CONFIG_NET_L2_IEEE802154_SECURITY \ CONFIG_NET_MGMT_EVENT \ CONFIG_NET_SOCKETS_POSIX_NAMES \ CONFIG_NET_TCP \ From c1d518e55c0dfa78a95996922540a2845e347c1c Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 14:29:07 +0200 Subject: [PATCH 06/10] cmake: bump to required Zephyr SDK v0.16.3 issues: #136 Signed-off-by: Stephan Linz --- scripts/tools-versions-linux.txt | 2 +- scripts/tools-versions-macos.txt | 2 +- scripts/tools-versions-minimum.txt | 2 +- scripts/tools-versions-win10.txt | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/tools-versions-linux.txt b/scripts/tools-versions-linux.txt index 4b1d695566..4359528b02 100644 --- a/scripts/tools-versions-linux.txt +++ b/scripts/tools-versions-linux.txt @@ -8,7 +8,7 @@ openocd=0.11.0-5 (xPack OpenOCD from GitHub) ccache=3.7.7-1 dfu-util=0.9-1 west=0.14.0 -zephyr-sdk=0.16.1 +zephyr-sdk=0.16.3 doxygen=1.9.2-1+ppa~tsn1~focal graphviz=2.42.2-3build2 mscgen=0.20-12 diff --git a/scripts/tools-versions-macos.txt b/scripts/tools-versions-macos.txt index 6679cfb512..aec2a4ae90 100644 --- a/scripts/tools-versions-macos.txt +++ b/scripts/tools-versions-macos.txt @@ -6,4 +6,4 @@ gperf=3.1;hash=258483ea2fd445d42d869d495504f960202fe0c3 dtc=1.4.7;hash=0747cc9d6b50ac8a3b1b576e4509494f2258aef2 openocd=0.11.0-5 (xPack OpenOCD from GitHub) west=0.14.0 -zephyr-sdk=0.16.1 +zephyr-sdk=0.16.3 diff --git a/scripts/tools-versions-minimum.txt b/scripts/tools-versions-minimum.txt index fc8259b81f..039f08648a 100644 --- a/scripts/tools-versions-minimum.txt +++ b/scripts/tools-versions-minimum.txt @@ -5,7 +5,7 @@ gperf=3.1 dtc=1.4.6 openocd=0.11 west=0.12 -zephyr-sdk=0.15.1 +zephyr-sdk=0.16.1 gnuarmemb=10-2020-q4-major doxygen=1.9.1 graphviz=2.42 diff --git a/scripts/tools-versions-win10.txt b/scripts/tools-versions-win10.txt index 6dc0047c7b..f2306117f1 100644 --- a/scripts/tools-versions-win10.txt +++ b/scripts/tools-versions-win10.txt @@ -6,4 +6,4 @@ gperf=3.1 dtc=1.4.7-1 openocd=0.11.0-5 (xPack OpenOCD from GitHub) west=0.14.0 -zephyr-sdk=0.16.1 +zephyr-sdk=0.16.3 From d5e739f04f5f0c77189ea1ef451b5dd5880cc911 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 14:33:09 +0200 Subject: [PATCH 07/10] devcontainer: bump Zephyr CI container to v0.26.5 Updated Zephyr SDK to 0.16.3. issues: #136 Signed-off-by: Stephan Linz --- .devcontainer/devcontainer.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index dbd5f9d015..5e895e332b 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -5,7 +5,7 @@ "dockerfile": "Dockerfile", // Specify version for Zephyr Container // See https://github.com/zephyrproject-rtos/docker-image/releases - "args": { "ZEPHYR_TAG": "v0.26.4" } + "args": { "ZEPHYR_TAG": "v0.26.5" } }, // Needed for USB devices in container "privileged": true, @@ -33,4 +33,4 @@ ] } } -} \ No newline at end of file +} From 2901d6dbeab63f7dd903235ab446adaeb798dc81 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 14:32:33 +0200 Subject: [PATCH 08/10] ci: github: bump Zephyr CI container to v0.26.5 Updated Zephyr SDK to 0.16.3. issues: #136 Signed-off-by: Stephan Linz --- .github/workflows/qa-integration.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/qa-integration.yml b/.github/workflows/qa-integration.yml index 5fefb9ad29..4ce0305df8 100644 --- a/.github/workflows/qa-integration.yml +++ b/.github/workflows/qa-integration.yml @@ -40,10 +40,10 @@ jobs: name: Run integration tests for samples runs-on: ubuntu-latest container: - image: ghcr.io/zephyrproject-rtos/ci:v0.26.4 + image: ghcr.io/zephyrproject-rtos/ci:v0.26.5 options: '--entrypoint /bin/bash' env: - ZEPHYR_SDK_INSTALL_DIR: /opt/toolchains/zephyr-sdk-0.16.1 + ZEPHYR_SDK_INSTALL_DIR: /opt/toolchains/zephyr-sdk-0.16.3 steps: - name: Apply container owner mismatch workaround @@ -124,10 +124,10 @@ jobs: name: Run integration tests for shields runs-on: ubuntu-latest container: - image: ghcr.io/zephyrproject-rtos/ci:v0.26.4 + image: ghcr.io/zephyrproject-rtos/ci:v0.26.5 options: '--entrypoint /bin/bash' env: - ZEPHYR_SDK_INSTALL_DIR: /opt/toolchains/zephyr-sdk-0.16.1 + ZEPHYR_SDK_INSTALL_DIR: /opt/toolchains/zephyr-sdk-0.16.3 steps: - name: Apply container owner mismatch workaround From ba32cc79d4a82b72f32b28894b4d5820f312f99e Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 14:41:04 +0200 Subject: [PATCH 09/10] ci: github: fix test report annotation name Signed-off-by: Stephan Linz --- .github/workflows/qa-integration.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/qa-integration.yml b/.github/workflows/qa-integration.yml index 4ce0305df8..feba6a8176 100644 --- a/.github/workflows/qa-integration.yml +++ b/.github/workflows/qa-integration.yml @@ -114,7 +114,7 @@ jobs: - name: Convert integration test reports to annotations uses: mikepenz/action-junit-report@v3 with: - check_name: twister-report (shields) + check_name: twister-report (samples) report_paths: "**/twister-out/twister.xml" require_tests: true fail_on_failure: false From 9f65da04662365ca3af06895b674751f53e01ffc Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Mon, 9 Oct 2023 14:37:47 +0200 Subject: [PATCH 10/10] release: update draft notes for upcoming 3.5.0 issues: #136 Signed-off-by: Stephan Linz --- doc/bridle/releases/release-notes-3.5.0.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/bridle/releases/release-notes-3.5.0.rst b/doc/bridle/releases/release-notes-3.5.0.rst index 283886a3a3..9eacd77e04 100644 --- a/doc/bridle/releases/release-notes-3.5.0.rst +++ b/doc/bridle/releases/release-notes-3.5.0.rst @@ -146,6 +146,8 @@ Take over the new build principles from Zephyr: * Remove all specific ``@uartcons`` board revisions. * Convert all active test cases to use the new Twister CLI argument ``--alt-config-root``. Also remove the abandoned shield ``can_timing_adj``. +* Updated Zephyr SDK to 0.16.3. Use Zephyr CI container v0.26.5 on GitHub CI + and as base image for local developer container in Vidual Studio Code. Documentation ============= @@ -166,6 +168,7 @@ Issue Related Items These GitHub issues were addressed since project bootstrapping: +* :github:`136` - [FCR] Bump to Zephyr SDK 0.16.3 * :github:`128` - [FER] Provide USB console by snippets instead of specific board revision * :github:`127` - [FER] Provide CAN timing tweak for TiaC Magpie by snippets instead of a shield * :github:`125` - [BUG] Nightly QA integration test fails (convert to ``stm32-bxcan``)