From 7ff51cae27c4bde8836d351a7a6f0dcc2ecfa34d Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Thu, 12 Sep 2024 06:53:58 +0200 Subject: [PATCH 1/7] doc: devicetree: hotfix to exclude new warnings With the upgrade to Python 3.10, some new Sphinx warnings occur or have to be handled with changed filter. Signed-off-by: Stephan Linz --- doc/devicetree/known-warnings-inventory.txt | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/devicetree/known-warnings-inventory.txt b/doc/devicetree/known-warnings-inventory.txt index 24a61096eb..f0a9f426bf 100644 --- a/doc/devicetree/known-warnings-inventory.txt +++ b/doc/devicetree/known-warnings-inventory.txt @@ -1,7 +1,5 @@ # Each line should contain the regular expression of a known Sphinx warning # that should be filtered out additional to the original filter set -# Coming later from zephyr docset -.*undefined label: 'dt-guide' -.*undefined label: 'zephyr:dt-bindings' -.*undefined label: 'zephyr:dt-important-props' +# Coming later from other docset +.*undefined label:.* From 8e00b3175a2292c2074d6adb11c16fe222878b0d Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Thu, 12 Sep 2024 06:55:25 +0200 Subject: [PATCH 2/7] doc: kconfig: hotfix to exclude new warnings With the upgrade to Python 3.10, some new Sphinx warnings occur or have to be handled with changed filter. Signed-off-by: Stephan Linz --- doc/kconfig/known-warnings-inventory.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/kconfig/known-warnings-inventory.txt b/doc/kconfig/known-warnings-inventory.txt index 0ede683747..f0a9f426bf 100644 --- a/doc/kconfig/known-warnings-inventory.txt +++ b/doc/kconfig/known-warnings-inventory.txt @@ -1,5 +1,5 @@ # Each line should contain the regular expression of a known Sphinx warning # that should be filtered out additional to the original filter set -# Coming later from zephyr docset -.*undefined label: 'kconfig' +# Coming later from other docset +.*undefined label:.* From 0e60e236ef491968403a39394d9f363978ccd593 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Thu, 12 Sep 2024 06:55:58 +0200 Subject: [PATCH 3/7] doc: zephyr: hotfix to exclude new warnings With the upgrade to Python 3.10, some new Sphinx warnings occur or have to be handled with changed filter. Signed-off-by: Stephan Linz --- doc/zephyr/known-warnings-inventory.txt | 6 ++---- doc/zephyr/known-warnings.txt | 7 +++++++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/zephyr/known-warnings-inventory.txt b/doc/zephyr/known-warnings-inventory.txt index f888f92194..b64a629592 100644 --- a/doc/zephyr/known-warnings-inventory.txt +++ b/doc/zephyr/known-warnings-inventory.txt @@ -1,9 +1,8 @@ # Each line should contain the regular expression of a known Sphinx warning # that should be filtered out additional to the original filter set -# Coming later from devicetree docset -.*undefined label: 'devicetree_binding_index' -.*undefined label: 'dt_vendor_zephyr' +# Coming later from other docset +.*undefined label:.* # # TODO: New warnings with Doxygen v1.9.8 - unknown reasons. @@ -17,7 +16,6 @@ # reference target in: zephyr/doc/develop/flash_debug/probes.rst:251 # referred to there in: zephyr/samples/bluetooth/hci_uart/README.rst:311 # -.*undefined label: 'using segger j-link' .*Duplicate explicit target name: "using segger j-link"\. # diff --git a/doc/zephyr/known-warnings.txt b/doc/zephyr/known-warnings.txt index cacc8e48fb..aa82d691db 100644 --- a/doc/zephyr/known-warnings.txt +++ b/doc/zephyr/known-warnings.txt @@ -6,3 +6,10 @@ # .*Error in declarator or parameters.* .*Invalid C declaration: Expected identifier in nested name.* + +# Function and (enum or struct) name +.*Duplicate C declaration.*\n.*'\.\. c:.*:: BT_.*'.* +.*Duplicate C declaration.*\n.*'\.\. c:.*:: FS_.*'.* +.*Duplicate C declaration.*\n.*'\.\. c:.*:: HID_REPORT_.*'.* +.*Duplicate C declaration.*\n.*'\.\. c:.*:: PCIE_SCAN_.*'.* +.*Duplicate C declaration.*\n.*'\.\. c:.*:: K_WORK_.*'.* From 37e0752e774a744e3232266992bcd36a0bbb2d7c Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Thu, 12 Sep 2024 06:56:19 +0200 Subject: [PATCH 4/7] doc: bridle: hotfix to exclude new warnings With the upgrade to Python 3.10, some new Sphinx warnings occur or have to be handled with changed filter. Signed-off-by: Stephan Linz --- doc/bridle/known-warnings-inventory.txt | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/bridle/known-warnings-inventory.txt b/doc/bridle/known-warnings-inventory.txt index 1b983bd68e..557e58748d 100644 --- a/doc/bridle/known-warnings-inventory.txt +++ b/doc/bridle/known-warnings-inventory.txt @@ -1,16 +1,12 @@ # Each line should contain the regular expression of a known Sphinx warning # that should be filtered out +# Coming later from other docset +.*undefined label:.* + # Coming later from zephyr docset .*term not in glossary: 'zephyr:.*' .*unknown document: 'zephyr:.*' -.*undefined label: 'zephyr:.*' - -# Coming later from kconfig docset -.*undefined label: 'kconfig:.*' - -# Coming later from devicetree docset -.*undefined label: 'devicetree:.*' # FIXME: Sphinx emits "toctree glob pattern %r didn't match any documents" # instead of: @@ -43,3 +39,17 @@ # reference target in: bridle/doc/bridle/gs_installing.rst:89 # .*Duplicate explicit target name: "install_dependencies_windows"\. + +# +# TODO: is ".. _cytron_maker_nano_rp2040:" +# or ".. _cytron_maker_pi_rp2040:" +# or ".. _cytron_maker_pi_rp2040_positions:" +# inside ".. group-tab::" realy working? +# +# reference target in: bridle/boards/cytron/maker_rp2040/doc/index.rst:21 +# reference target in: bridle/boards/cytron/maker_rp2040/doc/index.rst:27 +# reference target in: bridle/boards/cytron/maker_rp2040/doc/index.rst:42 +# +.*Duplicate explicit target name: "cytron_maker_nano_rp2040"\. +.*Duplicate explicit target name: "cytron_maker_pi_rp2040"\. +.*Duplicate explicit target name: "cytron_maker_pi_rp2040_positions"\. From ad4a8097fdf1dccb6d22f14ef97fffed9669bd46 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Wed, 11 Sep 2024 07:49:54 +0200 Subject: [PATCH 5/7] doc: bump required tool versions git, west, cmake, openocd Signed-off-by: Stephan Linz --- scripts/tools-versions-linux.txt | 16 ++++++++-------- scripts/tools-versions-macos.txt | 16 ++++++++-------- scripts/tools-versions-minimum.txt | 6 +++--- scripts/tools-versions-win10.txt | 12 ++++++------ 4 files changed, 25 insertions(+), 25 deletions(-) diff --git a/scripts/tools-versions-linux.txt b/scripts/tools-versions-linux.txt index af4712f641..f305f0c8a8 100644 --- a/scripts/tools-versions-linux.txt +++ b/scripts/tools-versions-linux.txt @@ -1,13 +1,13 @@ -python3=3.8.2-0ubuntu2 -git=1:2.25.1-1ubuntu3.5 -cmake=3.27.7-0kitware1ubuntu20.04.1 -ninja-build=1.10.0-1build1 +python3=3.10.4-0ubuntu2 +git=1:2.34.1-1ubuntu1.11 +cmake=3.22.1-1ubuntu1.22.04.2 +ninja-build=1.10.1-1 gperf=3.1-1build1 -device-tree-compiler=1.5.1-1 -openocd=0.11.0-5 (xPack OpenOCD from GitHub) -ccache=3.7.7-1 +device-tree-compiler=1.6.1-1 +openocd=0.12.0-4 (xPack OpenOCD from GitHub) +ccache=4.5.1-1 dfu-util=0.9-1 -west=0.14.0 +west=1.2.0 zephyr-sdk=0.16.8 armgnutc=13.2.rel1 gnuarmemb=10.3-2021.10 diff --git a/scripts/tools-versions-macos.txt b/scripts/tools-versions-macos.txt index 07d17c69c7..d936777bee 100644 --- a/scripts/tools-versions-macos.txt +++ b/scripts/tools-versions-macos.txt @@ -1,11 +1,11 @@ -python=3.8.2;hash=b703318dd9eb7bc5e8d97c8b95e9445f754ca22f -git=2.26.2;hash=fd0766dbc0032ff22914cae6530440c48757c4e1 -cmake=3.20.5 -ninja=1.9.0 -gperf=3.1;hash=258483ea2fd445d42d869d495504f960202fe0c3 -dtc=1.4.7;hash=0747cc9d6b50ac8a3b1b576e4509494f2258aef2 -openocd=0.11.0-5 (xPack OpenOCD from GitHub) -west=0.14.0 +python=3.10.6 +git=2.34.1 +cmake=3.22.6-1 (xPack CMake from GitHub) +ninja=1.10.1-1 (xPack ninja-build from GitHub) +gperf=3.1 +dtc=1.4.7 +openocd=0.12.0-4 (xPack OpenOCD from GitHub) +west=1.2.0 zephyr-sdk=0.16.8 armgnutc=13.2.rel1 gnuarmemb=10.3-2021.10 diff --git a/scripts/tools-versions-minimum.txt b/scripts/tools-versions-minimum.txt index 4bc8089644..f6c28fa9ce 100644 --- a/scripts/tools-versions-minimum.txt +++ b/scripts/tools-versions-minimum.txt @@ -1,10 +1,10 @@ -python=3.8 -cmake=3.20 +python=3.10 +cmake=3.20.5 ninja=1.8.2 gperf=3.1 dtc=1.4.6 openocd=0.11 -west=0.12 +west=0.14 zephyr-sdk=0.16.7 armgnutc=11.2-2022.02 gnuarmemb=10-2020-q4-major diff --git a/scripts/tools-versions-win10.txt b/scripts/tools-versions-win10.txt index dceced403f..2853e35acf 100644 --- a/scripts/tools-versions-win10.txt +++ b/scripts/tools-versions-win10.txt @@ -1,11 +1,11 @@ -python=3.8.2 -git=2.26.2.windows.1 -cmake=3.20.5 -ninja=1.9.0 +python=3.10.6 +git=2.34.1.windows.1 +cmake=3.22.6-1 (xPack CMake from GitHub) +ninja=1.10.1-1 (xPack ninja-build from GitHub) gperf=3.1 dtc=1.4.7-1 -openocd=0.11.0-5 (xPack OpenOCD from GitHub) -west=0.14.0 +openocd=0.12.0-4 (xPack OpenOCD from GitHub) +west=1.2.0 zephyr-sdk=0.16.8 armgnutc=13.2.rel1 gnuarmemb=10.3-2021.10 From 7586d083ff45bde7bbd0d723271e0e5432ee59e6 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Thu, 12 Sep 2024 06:51:04 +0200 Subject: [PATCH 6/7] requirements: change differet PyPi packages - documentation: sphinx to ~7.4 Signed-off-by: Stephan Linz --- scripts/requirements-doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/requirements-doc.txt b/scripts/requirements-doc.txt index 0f0d2f9745..ac243e8165 100644 --- a/scripts/requirements-doc.txt +++ b/scripts/requirements-doc.txt @@ -2,7 +2,7 @@ breathe>=4.35 docutils>=0.18 doxmlparser~=1.10 pygments~=2.18 -sphinx~=7.1 +sphinx~=7.4 sphinx-tsn-theme~=2024.1 sphinxcontrib-mscgen~=0.6 sphinxcontrib-svg2pdfconverter~=1.2 From 0a261b7d102347f29ed044eaa1301dabc845f33f Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Thu, 12 Sep 2024 07:03:18 +0200 Subject: [PATCH 7/7] release: add draft notes for upcoming 3.7.0 - bump required tool versions: Python v3.10, CMake v3.20.5 - change required PyPi versions: Sphinx ~7.4 Signed-off-by: Stephan Linz --- doc/bridle/releases/release-notes-3.7.0.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/bridle/releases/release-notes-3.7.0.rst b/doc/bridle/releases/release-notes-3.7.0.rst index 88545986b3..5cf2f92161 100644 --- a/doc/bridle/releases/release-notes-3.7.0.rst +++ b/doc/bridle/releases/release-notes-3.7.0.rst @@ -214,6 +214,8 @@ Take over the new build principles from Zephyr: * tbd. * tbd. * tbd. +* Update of the minimum requirements for Python to version 3.10. +* Update of the minimum requirements for CMake to version 3.20.5. * Use the new upstream *MIPI DBI driver class* for all *ST7735R* based displays. * Use the new upstream *MIPI DBI driver class* for all *ST7789V* based displays. * Convert all Bridle *boards* and *SoCs* to the **new Hardware Model v2**.