Skip to content
This repository has been archived by the owner on Jul 31, 2024. It is now read-only.

Commit

Permalink
docs: update links to Zephyr docs to point at version 3.5.0
Browse files Browse the repository at this point in the history
Do 's/3.3.0/3.4.0/' for most parts and rename ESP32 to ESP32-DEVKITC-WROOM.

Signed-off-by: Marcin Niestroj <[email protected]>
  • Loading branch information
mniestroj committed Oct 23, 2023
1 parent 17d4f1d commit 752d572
Show file tree
Hide file tree
Showing 14 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ During release testing, all boards and services are verified using sample applic
+------------------+--------------+-------------+----------+

.. _Zephyr RTOS: https://www.zephyrproject.org/
.. _west: https://docs.zephyrproject.org/3.4.0/develop/west/index.html
.. _Zephyr Getting Started: https://docs.zephyrproject.org/3.4.0/develop/getting_started/index.html
.. _west: https://docs.zephyrproject.org/3.5.0/develop/west/index.html
.. _Zephyr Getting Started: https://docs.zephyrproject.org/3.5.0/develop/getting_started/index.html
.. _nRF Connect SDK: https://www.nordicsemi.com/Software-and-tools/Software/nRF-Connect-SDK
.. _nRF Connect SDK Getting Started: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/gs_installing.html
.. _nRF9160 DK: https://www.nordicsemi.com/Products/Development-hardware/nrf9160-dk
Expand Down
6 changes: 3 additions & 3 deletions samples/certificate_provisioning/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ sample application (i.e. ``samples/certificate_provisioning``) and type:
$ west build -b esp32_devkitc_wroom samples/certificate_provisioning
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -214,7 +214,7 @@ This is the output from the serial console:
[00:00:15.833,404] <inf> golioth_hello: Sending hello! 1
[00:00:20.833,496] <inf> golioth_hello: Sending hello! 2
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _mcumgr: https://docs.zephyrproject.org/latest/services/device_mgmt/mcumgr.html
.. _golioth cert auth: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/certificate-auth
6 changes: 3 additions & 3 deletions samples/dfu/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ Related documentation:

.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _MCUboot: https://docs.zephyrproject.org/3.4.0/services/device_mgmt/dfu.html#mcuboot
.. _Signing Binaries: https://docs.zephyrproject.org/3.4.0/develop/west/sign.html#west-sign
.. _Flash map: https://docs.zephyrproject.org/3.4.0/services/storage/flash_map/flash_map.html
.. _MCUboot: https://docs.zephyrproject.org/3.5.0/services/device_mgmt/dfu.html#mcuboot
.. _Signing Binaries: https://docs.zephyrproject.org/3.5.0/develop/west/sign.html#west-sign
.. _Flash map: https://docs.zephyrproject.org/3.5.0/services/storage/flash_map/flash_map.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/hello/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/hello``) and type:
$ west build -b esp32_devkitc_wroom samples/hello
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -228,6 +228,6 @@ means that communication with Golioth is working.

.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/hello_sporadic/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/hello_sporadic``) and type:
$ west build -b esp32_devkitc_wroom samples/hello_sporadic
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -235,6 +235,6 @@ This is the output from the serial console:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/lightdb/delete/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ sample application (i.e., ``samples/lightdb/delete``) and type:
$ west build -b esp32_devkitc_wroom samples/lightdb/delete
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -240,6 +240,6 @@ The value can be set with:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/lightdb/get/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ sample application (i.e., ``samples/lightdb/get``) and type:
$ west build -b esp32_devkitc_wroom samples/lightdb/get
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -246,6 +246,6 @@ The value can be set with:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/lightdb/observe/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/lightdb/observe``) and type:
$ west build -b esp32_devkitc_wroom samples/lightdb/observe
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -240,6 +240,6 @@ retrieves it every time that it's updated. The value can be updates as such:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/lightdb/set/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/lightdb/set``) and type:
$ west build -b esp32_devkitc_wroom samples/lightdb/set
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -245,6 +245,6 @@ with its value. Current value can be fetched using following command:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/lightdb_led/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/lightdb_led``) and type:
$ west build -b esp32_devkitc_wroom samples/lightdb_led
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -261,6 +261,6 @@ as:

.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/lightdb_stream/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ sample application (i.e., ``samples/lightdb_stream``) and type:
$ west build -b esp32_devkitc_wroom samples/lightdb_stream
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -323,6 +323,6 @@ Historical data can be queried using following command:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/logging/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/logging``) and type:
$ west build -b esp32_devkitc_wroom samples/logging
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -265,6 +265,6 @@ This is how logs are visible
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
6 changes: 3 additions & 3 deletions samples/rpc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ sample application (i.e., ``samples/rpc``) and type:
$ west build -b esp32_devkitc_wroom samples/rpc
$ west flash
See `ESP32`_ for details on how to use ESP32 board.
See `ESP32-DEVKITC-WROOM`_ for details on how to use ESP32 board.

nRF52840 DK + ESP32-WROOM-32
----------------------------
Expand Down Expand Up @@ -232,6 +232,6 @@ This is the output from the serial console:
.. _authentication methods: https://docs.golioth.io/firmware/zephyr-device-sdk/authentication/
.. _Zephyr Settings subsystem: https://docs.zephyrproject.org/latest/services/settings/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _ESP32: https://docs.zephyrproject.org/3.4.0/boards/xtensa/esp32/doc/index.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html
.. _ESP32-DEVKITC-WROOM: https://docs.zephyrproject.org/3.5.0/boards/xtensa/esp32_devkitc_wroom/doc/index.html
.. _AT Binary Lists: https://docs.espressif.com/projects/esp-at/en/latest/AT_Binary_Lists/index.html
2 changes: 1 addition & 1 deletion tests/lightdb/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ Run ``twister``:
zephyr/scripts/twister -p qemu_x86 -T modules/lib/golioth/tests/lightdb
.. _Networking with QEMU: https://docs.zephyrproject.org/3.4.0/connectivity/networking/qemu_setup.html
.. _Networking with QEMU: https://docs.zephyrproject.org/3.5.0/connectivity/networking/qemu_setup.html

0 comments on commit 752d572

Please sign in to comment.