From 28946ab8826b7dca98f71174131a0a80299730b8 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Wed, 20 Nov 2024 12:50:14 +0100 Subject: [PATCH 1/4] requirements: change and add differet PyPi packages - build: regex to >=2024.11 - documentation: sphinx-tsn-theme to ~2024.11 Signed-off-by: Stephan Linz --- scripts/requirements-build.txt | 2 +- scripts/requirements-doc.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/requirements-build.txt b/scripts/requirements-build.txt index fa1f61e6e2..fb81b79673 100644 --- a/scripts/requirements-build.txt +++ b/scripts/requirements-build.txt @@ -3,7 +3,7 @@ imagesize>=1.4 intelhex>=2.3 pyelftools>=0.31 pylint>=3.3 -regex>=2024.9 +regex>=2024.11 # # Interim solution as long as the discussion continues upstream, diff --git a/scripts/requirements-doc.txt b/scripts/requirements-doc.txt index 284a507742..7c6796084d 100644 --- a/scripts/requirements-doc.txt +++ b/scripts/requirements-doc.txt @@ -4,7 +4,7 @@ doxmlparser~=1.12 pygments~=2.18 sphobjinv~=2.3 sphinx~=8.1 -sphinx-tsn-theme~=2024.10 +sphinx-tsn-theme~=2024.11 sphinxcontrib-mscgen~=0.6 sphinxcontrib-svg2pdfconverter~=1.2 sphinx-autobuild~=2024.10 From d1ac0a713853605622e3abfcc4dad86699dac5de Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Wed, 20 Nov 2024 12:59:07 +0100 Subject: [PATCH 2/4] doc: fix version string handling Extends the `version` variable with the extra string so that the HTML builder together with the corresponding theme can output the correct version number. The new variable `shortversion`, also integrated as a Sphinx replacement, can now be used within the Bridle documentation for the correct output from the `bridle version` command. Signed-off-by: Stephan Linz --- doc/bridle/conf.py | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/doc/bridle/conf.py b/doc/bridle/conf.py index c5053ca8c0..73e892ef07 100644 --- a/doc/bridle/conf.py +++ b/doc/bridle/conf.py @@ -64,10 +64,12 @@ version = longversion = 'Unknown' else: major, minor, patch, tweak, extra = m.groups(1) - release = version = longversion = ".".join((major, minor, patch)) + release = version = ".".join((major, minor, patch)) + shortversion = longversion = version if tweak: longversion += "." + tweak if extra: + version += "-" + extra release += "-" + extra # parse Zephyr version from 'VERSION' file @@ -89,18 +91,20 @@ zephyr_version = zephyr_longversion = 'Unknown' else: major, minor, patch, tweak, extra = m.groups(1) - zephyr_release = zephyr_version = zephyr_longversion = ".".join((major, minor, patch)) + zephyr_release = zephyr_version = ".".join((major, minor, patch)) + zephyr_shortversion = zephyr_longversion = zephyr_version zephyr_urb_bcddevice = '{:d}.{:02d}'.format(int(major), int(minor)) if tweak: zephyr_longversion += "." + tweak if extra: + zephyr_version += "-" + extra zephyr_release += "-" + extra # Overview --------------------------------------------------------------------- logcfg = sphinx.util.logging.getLogger(__name__) -logcfg.info(project + ' ' + release + ' (' + longversion + ')', color='yellow') -logcfg.info('With Zephyr {} ({})'.format(zephyr_release, zephyr_longversion), color='green') +logcfg.info(project + ' ' + version + ' (' + longversion + ')', color='yellow') +logcfg.info('With Zephyr {} ({})'.format(zephyr_version, zephyr_longversion), color='green') logcfg.info('With URB bcdDevice "{}"'.format(zephyr_urb_bcddevice), color='green') logcfg.info('Build with tags: ' + ':'.join(map(str, tags)), color='red') logcfg.info('BRIDLE_BASE is: "{}"'.format(BRIDLE_BASE), color='green') @@ -200,6 +204,12 @@ .. |version_number| replace:: {version} .. |version_number_tt| replace:: ``{version}`` .. |version_number_em| replace:: *{version}* +.. |shortversion| replace:: v{shortversion} +.. |shortversion_tt| replace:: ``v{shortversion}`` +.. |shortversion_em| replace:: *v{shortversion}* +.. |shortversion_number| replace:: {shortversion} +.. |shortversion_number_tt| replace:: ``{shortversion}`` +.. |shortversion_number_em| replace:: *{shortversion}* .. |longversion| replace:: v{longversion} .. |longversion_tt| replace:: ``v{longversion}`` .. |longversion_em| replace:: *v{longversion}* @@ -218,6 +228,12 @@ .. |zephyr_version_number| replace:: {zephyr_version} .. |zephyr_version_number_tt| replace:: ``{zephyr_version}`` .. |zephyr_version_number_em| replace:: *{zephyr_version}* +.. |zephyr_shortversion| replace:: v{zephyr_shortversion} +.. |zephyr_shortversion_tt| replace:: ``v{zephyr_shortversion}`` +.. |zephyr_shortversion_em| replace:: *v{zephyr_shortversion}* +.. |zephyr_shortversion_number| replace:: {zephyr_shortversion} +.. |zephyr_shortversion_number_tt| replace:: ``{zephyr_shortversion}`` +.. |zephyr_shortversion_number_em| replace:: *{zephyr_shortversion}* .. |zephyr_longversion| replace:: v{zephyr_longversion} .. |zephyr_longversion_tt| replace:: ``v{zephyr_longversion}`` .. |zephyr_longversion_em| replace:: *v{zephyr_longversion}* @@ -228,9 +244,11 @@ '''.format( release = release, version = version, + shortversion = shortversion, longversion = longversion, zephyr_release = zephyr_release, zephyr_version = zephyr_version, + zephyr_shortversion = zephyr_shortversion, zephyr_longversion = zephyr_longversion, zephyr_urb_bcddevice = zephyr_urb_bcddevice, ) From 03623ad8aae78ae2f678194e1febf7a37d3e42a3 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Wed, 20 Nov 2024 13:53:35 +0100 Subject: [PATCH 3/4] doc: fix version string in helloshell console output Use the new replacement with the `shortversion` number. Signed-off-by: Stephan Linz --- .../cytron/maker_rp2040/doc/maker-nano-rp2040/helloshell.rsti | 2 +- boards/cytron/maker_rp2040/doc/maker-pi-rp2040/helloshell.rsti | 2 +- boards/extensions/zero/doc/index.rst | 2 +- boards/jsed/picoboy/doc/helloshell.rsti | 2 +- boards/seeed/seeeduino_cm0/doc/index.rst | 2 +- boards/seeed/seeeduino_lotus/doc/index.rst | 2 +- boards/seeed/xiao_samd21/doc/index.rst | 2 +- boards/shields/nxp_sc18is604_evb/doc/helloshell_console.rsti | 2 +- .../rpi_pico_bb/doc/geeekpi_pico_bb/helloshell_console.rsti | 2 +- .../doc/geeekpi_pico_bb_plus/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_clock_green/helloshell.rsti | 2 +- .../doc/pimoroni_pico_lcd_1_44/helloshell_console.rsti | 2 +- .../doc/pimoroni_pico_lcd_2/helloshell_console.rsti | 2 +- .../doc/spotpear_pico_lcd_1_54/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_lcd_0_96/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_lcd_1_14/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_lcd_1_3/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_lcd_1_44/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_lcd_1_8/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_lcd_2/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_restouch_lcd_2_8/helloshell_console.rsti | 2 +- .../doc/waveshare_pico_restouch_lcd_3_5/helloshell_console.rsti | 2 +- .../rpi_pico_test/doc/spotpear_pico_test/helloshell.rsti | 2 +- boards/shields/tcs-604/doc/helloshell_console.rsti | 2 +- .../waveshare_pico_10dof_imu_sensor/doc/helloshell-r1.rsti | 2 +- .../waveshare_pico_10dof_imu_sensor/doc/helloshell-r2.rsti | 2 +- .../waveshare_pico_environment_sensor/doc/helloshell.rsti | 2 +- boards/tiac/magpie_f777ni/doc/samples/basic/helloshell.rst | 2 +- boards/tiac/magpie_f777ni/doc/samples/net/telnet.rst | 2 +- boards/waveshare/rp2040/doc/rp2040-eth/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-geek/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-lcd-0.96/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-matrix/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-one/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-plus/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-tiny/helloshell.rsti | 2 +- boards/waveshare/rp2040/doc/rp2040-zero/helloshell.rsti | 2 +- samples/helloshell/README.rst | 2 +- 38 files changed, 38 insertions(+), 38 deletions(-) diff --git a/boards/cytron/maker_rp2040/doc/maker-nano-rp2040/helloshell.rsti b/boards/cytron/maker_rp2040/doc/maker-nano-rp2040/helloshell.rsti index 5e7146afcc..c070d96419 100644 --- a/boards/cytron/maker_rp2040/doc/maker-nano-rp2040/helloshell.rsti +++ b/boards/cytron/maker_rp2040/doc/maker-nano-rp2040/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/cytron/maker_rp2040/doc/maker-pi-rp2040/helloshell.rsti b/boards/cytron/maker_rp2040/doc/maker-pi-rp2040/helloshell.rsti index 98fc6906fc..576907e34d 100644 --- a/boards/cytron/maker_rp2040/doc/maker-pi-rp2040/helloshell.rsti +++ b/boards/cytron/maker_rp2040/doc/maker-pi-rp2040/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/extensions/zero/doc/index.rst b/boards/extensions/zero/doc/index.rst index 98491255aa..1d96bf7131 100644 --- a/boards/extensions/zero/doc/index.rst +++ b/boards/extensions/zero/doc/index.rst @@ -491,7 +491,7 @@ Hello Shell with USB-CDC/ACM Console Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/jsed/picoboy/doc/helloshell.rsti b/boards/jsed/picoboy/doc/helloshell.rsti index 5e7bc62404..2d6df7afc5 100644 --- a/boards/jsed/picoboy/doc/helloshell.rsti +++ b/boards/jsed/picoboy/doc/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/seeed/seeeduino_cm0/doc/index.rst b/boards/seeed/seeeduino_cm0/doc/index.rst index ed22563c4d..d333d82b25 100644 --- a/boards/seeed/seeeduino_cm0/doc/index.rst +++ b/boards/seeed/seeeduino_cm0/doc/index.rst @@ -441,7 +441,7 @@ Hello Shell with USB-CDC/ACM Console Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/seeed/seeeduino_lotus/doc/index.rst b/boards/seeed/seeeduino_lotus/doc/index.rst index 52b1d8a7c7..d4b2f58d53 100644 --- a/boards/seeed/seeeduino_lotus/doc/index.rst +++ b/boards/seeed/seeeduino_lotus/doc/index.rst @@ -441,7 +441,7 @@ Hello Shell with USB-CDC/ACM Console Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/seeed/xiao_samd21/doc/index.rst b/boards/seeed/xiao_samd21/doc/index.rst index 321a615a2a..5264c60a6e 100644 --- a/boards/seeed/xiao_samd21/doc/index.rst +++ b/boards/seeed/xiao_samd21/doc/index.rst @@ -434,7 +434,7 @@ Hello Shell with USB-CDC/ACM Console Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/nxp_sc18is604_evb/doc/helloshell_console.rsti b/boards/shields/nxp_sc18is604_evb/doc/helloshell_console.rsti index aad9694044..636d3b35f5 100644 --- a/boards/shields/nxp_sc18is604_evb/doc/helloshell_console.rsti +++ b/boards/shields/nxp_sc18is604_evb/doc/helloshell_console.rsti @@ -36,7 +36,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb/helloshell_console.rsti b/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb/helloshell_console.rsti index 684c1411b3..448c543d6a 100644 --- a/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb/helloshell_console.rsti +++ b/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb_plus/helloshell_console.rsti b/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb_plus/helloshell_console.rsti index d83537673d..9b48d14138 100644 --- a/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb_plus/helloshell_console.rsti +++ b/boards/shields/rpi_pico_bb/doc/geeekpi_pico_bb_plus/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_clock/doc/waveshare_pico_clock_green/helloshell.rsti b/boards/shields/rpi_pico_clock/doc/waveshare_pico_clock_green/helloshell.rsti index 63ecaef9de..430bc541e3 100644 --- a/boards/shields/rpi_pico_clock/doc/waveshare_pico_clock_green/helloshell.rsti +++ b/boards/shields/rpi_pico_clock/doc/waveshare_pico_clock_green/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_1_44/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_1_44/helloshell_console.rsti index 1173456b34..cda3d46364 100644 --- a/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_1_44/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_1_44/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_2/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_2/helloshell_console.rsti index 1173456b34..cda3d46364 100644 --- a/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_2/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/pimoroni_pico_lcd_2/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/spotpear_pico_lcd_1_54/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/spotpear_pico_lcd_1_54/helloshell_console.rsti index 49b3236e2c..93806c3809 100644 --- a/boards/shields/rpi_pico_lcd/doc/spotpear_pico_lcd_1_54/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/spotpear_pico_lcd_1_54/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_0_96/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_0_96/helloshell_console.rsti index 74bf0b684c..a15098db76 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_0_96/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_0_96/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_14/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_14/helloshell_console.rsti index 74bf0b684c..a15098db76 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_14/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_14/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_3/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_3/helloshell_console.rsti index 74bf0b684c..a15098db76 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_3/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_3/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_44/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_44/helloshell_console.rsti index 5ebd48cbda..2c7a7268b9 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_44/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_44/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_8/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_8/helloshell_console.rsti index de59687d79..520836438b 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_8/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_1_8/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_2/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_2/helloshell_console.rsti index 85f91e09b3..0b90c90d84 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_2/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_lcd_2/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_2_8/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_2_8/helloshell_console.rsti index de59687d79..520836438b 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_2_8/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_2_8/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_3_5/helloshell_console.rsti b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_3_5/helloshell_console.rsti index de59687d79..520836438b 100644 --- a/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_3_5/helloshell_console.rsti +++ b/boards/shields/rpi_pico_lcd/doc/waveshare_pico_restouch_lcd_3_5/helloshell_console.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/rpi_pico_test/doc/spotpear_pico_test/helloshell.rsti b/boards/shields/rpi_pico_test/doc/spotpear_pico_test/helloshell.rsti index d23037b733..e00cef2b73 100644 --- a/boards/shields/rpi_pico_test/doc/spotpear_pico_test/helloshell.rsti +++ b/boards/shields/rpi_pico_test/doc/spotpear_pico_test/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/tcs-604/doc/helloshell_console.rsti b/boards/shields/tcs-604/doc/helloshell_console.rsti index ccfd4974f4..7d7d8cf8ab 100644 --- a/boards/shields/tcs-604/doc/helloshell_console.rsti +++ b/boards/shields/tcs-604/doc/helloshell_console.rsti @@ -35,7 +35,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r1.rsti b/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r1.rsti index decf4d7ea9..345c272984 100644 --- a/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r1.rsti +++ b/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r1.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r2.rsti b/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r2.rsti index 1bcbb2070e..5df525a464 100644 --- a/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r2.rsti +++ b/boards/shields/waveshare_pico_10dof_imu_sensor/doc/helloshell-r2.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/shields/waveshare_pico_environment_sensor/doc/helloshell.rsti b/boards/shields/waveshare_pico_environment_sensor/doc/helloshell.rsti index 1a78a7ba73..076b8b6289 100644 --- a/boards/shields/waveshare_pico_environment_sensor/doc/helloshell.rsti +++ b/boards/shields/waveshare_pico_environment_sensor/doc/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/tiac/magpie_f777ni/doc/samples/basic/helloshell.rst b/boards/tiac/magpie_f777ni/doc/samples/basic/helloshell.rst index cfa13b643d..1637d11864 100644 --- a/boards/tiac/magpie_f777ni/doc/samples/basic/helloshell.rst +++ b/boards/tiac/magpie_f777ni/doc/samples/basic/helloshell.rst @@ -111,7 +111,7 @@ prompt. All shell commands are available and would looks like: Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/tiac/magpie_f777ni/doc/samples/net/telnet.rst b/boards/tiac/magpie_f777ni/doc/samples/net/telnet.rst index 59b274645d..ce9e30b944 100644 --- a/boards/tiac/magpie_f777ni/doc/samples/net/telnet.rst +++ b/boards/tiac/magpie_f777ni/doc/samples/net/telnet.rst @@ -107,7 +107,7 @@ or ``kernel version``. Zephyr version |zephyr_version_number_em| :bgn:`~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`~$` **device list** devices: diff --git a/boards/waveshare/rp2040/doc/rp2040-eth/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-eth/helloshell.rsti index adf25ccb6a..3d0b52cd80 100644 --- a/boards/waveshare/rp2040/doc/rp2040-eth/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-eth/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-geek/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-geek/helloshell.rsti index bd946079be..08b05ab542 100644 --- a/boards/waveshare/rp2040/doc/rp2040-geek/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-geek/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-lcd-0.96/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-lcd-0.96/helloshell.rsti index a7bf2d9d83..6d150df6b0 100644 --- a/boards/waveshare/rp2040/doc/rp2040-lcd-0.96/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-lcd-0.96/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-matrix/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-matrix/helloshell.rsti index 013a6baf7d..f92287dda7 100644 --- a/boards/waveshare/rp2040/doc/rp2040-matrix/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-matrix/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-one/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-one/helloshell.rsti index 8d6d2855a2..3146231214 100644 --- a/boards/waveshare/rp2040/doc/rp2040-one/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-one/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-plus/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-plus/helloshell.rsti index fb34bea7e9..72e3ffff6c 100644 --- a/boards/waveshare/rp2040/doc/rp2040-plus/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-plus/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-tiny/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-tiny/helloshell.rsti index b740319b22..5ee5b1af59 100644 --- a/boards/waveshare/rp2040/doc/rp2040-tiny/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-tiny/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/boards/waveshare/rp2040/doc/rp2040-zero/helloshell.rsti b/boards/waveshare/rp2040/doc/rp2040-zero/helloshell.rsti index 071b7a33dc..73f8de96e3 100644 --- a/boards/waveshare/rp2040/doc/rp2040-zero/helloshell.rsti +++ b/boards/waveshare/rp2040/doc/rp2040-zero/helloshell.rsti @@ -27,7 +27,7 @@ Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| diff --git a/samples/helloshell/README.rst b/samples/helloshell/README.rst index 4f8dda1bb2..c95917d827 100644 --- a/samples/helloshell/README.rst +++ b/samples/helloshell/README.rst @@ -225,7 +225,7 @@ Sample Output Zephyr version |zephyr_version_number_em| :bgn:`uart:~$` **bridle version** - Bridle version |version_number_em| + Bridle version |shortversion_number_em| :bgn:`uart:~$` **bridle version long** Bridle version |longversion_number_em| From 6b4b66614645d8f2d39c412ac85fc2a066dd1bb2 Mon Sep 17 00:00:00 2001 From: Stephan Linz Date: Wed, 20 Nov 2024 14:12:42 +0100 Subject: [PATCH 4/4] release: add draft notes for upcoming 4.0.0 Add GitHub issues #275. Signed-off-by: Stephan Linz --- doc/bridle/releases/release-notes-4.0.0.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/bridle/releases/release-notes-4.0.0.rst b/doc/bridle/releases/release-notes-4.0.0.rst index ff2f019d44..8837d22155 100644 --- a/doc/bridle/releases/release-notes-4.0.0.rst +++ b/doc/bridle/releases/release-notes-4.0.0.rst @@ -246,6 +246,7 @@ Issue Related Items These GitHub issues were addressed since project bootstrapping: +* :github:`275` - [BUG] Lost Bridle's document version selector * :github:`274` - [FCR] Bump to Zephyr v4.0 * :github:`272` - [BUG] build all Bridle samples test runs into ``devicetree error`` * :github:`271` - [BUG] build all GPIO drivers test runs into ``devicetree error``