From 6c1f001e5bca6be08ff4785479e8fddb60f5ba1f Mon Sep 17 00:00:00 2001 From: divya pillai Date: Fri, 12 Jan 2024 11:47:37 +0100 Subject: [PATCH] doc: update doc for 2.5.2 Updating and creating release-related doc files. Signed-off-by: divya pillai --- doc/nrf/conf.py | 2 +- doc/nrf/links.txt | 4 + .../developing/adding_code.rst | 4 +- .../releases_and_maturity/release_notes.rst | 1 + .../releases/release-notes-2.5.2.rst | 117 ++++++++++++++++ .../software_maturity.rst | 130 +++++++++++++++--- doc/nrf/shortcuts.txt | 6 +- doc/nrfxlib/conf.py | 2 +- doc/versions.json | 1 + 9 files changed, 240 insertions(+), 27 deletions(-) create mode 100644 doc/nrf/releases_and_maturity/releases/release-notes-2.5.2.rst diff --git a/doc/nrf/conf.py b/doc/nrf/conf.py index fd0f3e221a01..019ab2ea318e 100644 --- a/doc/nrf/conf.py +++ b/doc/nrf/conf.py @@ -28,7 +28,7 @@ project = "nRF Connect SDK" copyright = "2019-2023, Nordic Semiconductor" author = "Nordic Semiconductor" -version = release = "2.5.1" +version = release = "2.5.2" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 04ab8a4cbea9..301c205f790e 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -232,6 +232,7 @@ .. _`nRF Connect SDK latest documentation`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/index.html .. _`known issues page on the main branch`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html +.. _`known issues for nRF Connect SDK v2.5.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-5-2 .. _`known issues for nRF Connect SDK v2.5.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-5-1 .. _`known issues for nRF Connect SDK v2.5.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-5-0 .. _`known issues for nRF Connect SDK v2.4.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-4-2 @@ -314,6 +315,7 @@ .. _`nRF socket options`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrfxlib/nrf_modem/doc/sockets.html#socket-options +.. _`Repositories and revisions for v2.5.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.2/nrf/releases_and_maturity/repository_revisions.html .. _`Repositories and revisions for v2.5.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.1/nrf/releases_and_maturity/repository_revisions.html .. _`Repositories and revisions for v2.5.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.0/nrf/introduction.html#ncs-repository-revisions .. _`Repositories and revisions for v2.4.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.2/nrf/introduction.html#ncs-repository-revisions @@ -333,6 +335,7 @@ .. _`Repositories and revisions for v1.9.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.1/nrf/introduction.html#repositories-and-revisions .. _`Repositories and revisions`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.0/nrf/introduction.html#repositories-and-revisions +.. _`Modem library changelog for v2.5.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.2/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog .. _`Modem library changelog for v2.5.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.1/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog .. _`Modem library changelog for v2.5.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog .. _`Modem library changelog for v2.4.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.2/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog @@ -352,6 +355,7 @@ .. _`Modem library changelog for v1.9.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.1/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog .. _`Modem library changelog for v1.9.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog +.. _`LwM2M carrier library changelog for v2.5.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.2/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog .. _`LwM2M carrier library changelog for v2.5.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.1/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog .. _`LwM2M carrier library changelog for v2.5.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.0/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog .. _`LwM2M carrier library changelog for v2.4.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.2/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog diff --git a/doc/nrf/releases_and_maturity/developing/adding_code.rst b/doc/nrf/releases_and_maturity/developing/adding_code.rst index c6a9c3d0e892..e83ab501641b 100644 --- a/doc/nrf/releases_and_maturity/developing/adding_code.rst +++ b/doc/nrf/releases_and_maturity/developing/adding_code.rst @@ -162,7 +162,7 @@ This is demonstrated by the following code, that would be placed somewhere in yo - name: nrf repo-path: sdk-nrf remote: ncs - revision: v2.5.1 + revision: v2.5.2 import: true self: path: application @@ -189,7 +189,7 @@ For example: projects: - name: nrf remote: ncs - revision: v2.5.1 + revision: v2.5.2 import: true # Example for how to override a repository in the nRF Connect SDK with your own: - name: mcuboot diff --git a/doc/nrf/releases_and_maturity/release_notes.rst b/doc/nrf/releases_and_maturity/release_notes.rst index 55bbbb3833df..6c6599dc43b1 100644 --- a/doc/nrf/releases_and_maturity/release_notes.rst +++ b/doc/nrf/releases_and_maturity/release_notes.rst @@ -19,6 +19,7 @@ This page is included only in the latest documentation, because it might contain :maxdepth: 1 :caption: Subpages: + releases/release-notes-2.5.2 releases/release-notes-2.5.1 releases/release-notes-2.5.0 releases/release-notes-2.4.2 diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-2.5.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.5.2.rst new file mode 100644 index 000000000000..e5184dd0c0ff --- /dev/null +++ b/doc/nrf/releases_and_maturity/releases/release-notes-2.5.2.rst @@ -0,0 +1,117 @@ +.. _ncs_release_notes_252: + +|NCS| v2.5.2 Release Notes +########################## + +.. contents:: + :local: + :depth: 2 + +|NCS| delivers reference software and supporting libraries for developing low-power wireless applications with Nordic Semiconductor products in the nRF52, nRF53, nRF70, and nRF91 Series. +The SDK includes open source projects (TF-M, MCUboot, OpenThread, Matter, and the Zephyr RTOS), which are continuously integrated and redistributed with the SDK. + +Release notes might refer to "experimental" support for features, which indicates that the feature is incomplete in functionality or verification, and can be expected to change in future releases. +To learn more, see :ref:`software_maturity`. + +Highlights +********** + +This patch release adds changes on top of the :ref:`nRF Connect SDK v2.5.0 ` and :ref:`nRF Connect SDK v2.5.1 `. +The changes affect Matter, Wi-FiĀ®, and SoftDevice Controller. + +See :ref:`ncs_release_notes_252_changelog` for the complete list of changes. + +Release tag +*********** + +The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.5.2**. +Check the :file:`west.yml` file for the corresponding tags in the project repositories. + +To use this release, check out the tag in the manifest repository and run ``west update``. +See :ref:`cloning_the_repositories` and :ref:`gs_updating_repos_examples` for more information. + +For information on the included repositories and revisions, see `Repositories and revisions for v2.5.2`_. + +IDE and tool support +******************** + +`nRF Connect for Visual Studio Code extension `_ is the only officially supported IDE for |NCS| v2.5.2. + +:ref:`gs_app_tcm`, used to install the |NCS| automatically from `nRF Connect for Desktop`_, is available for Windows, Linux, and macOS. + +Supported modem firmware +************************ + +See `Modem firmware compatibility matrix`_ for an overview of which modem firmware versions have been tested with this version of the |NCS|. + +Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware. +See :ref:`nrf9160_gs_updating_fw_modem` for instructions. + +Modem-related libraries and versions +==================================== + +.. list-table:: Modem-related libraries and versions + :widths: 15 10 + :header-rows: 1 + + * - Library name + - Version information + * - Modem library + - `Changelog `_ + * - LwM2M carrier library + - `Changelog `_ + +Known issues +************ + +Known issues are only tracked for the latest official release. +See `known issues for nRF Connect SDK v2.5.2`_ for the list of issues valid for the latest release. + +.. _ncs_release_notes_252_changelog: + +Changelog +********* + +The following sections provide detailed lists of changes by component. + +Protocols +========= + +This section provides detailed lists of changes by :ref:`protocol `. + +Bluetooth +--------- + +* Fixed an issue that affects SoftDevice Controller when running in continuous scan mode. + The controller may end up in an irresponsive state due to this issue. + See the :ref:`changelog ` of the SoftDevice Controller library for additional information. + +Matter +------ + +* Fixed: + + * An issue where the Matter device's application crashes if the DNS resolve response is processed with the TXT record's data size equal to ``0`` (KRKNWK-18256). + * An issue with the IPv6 address update in the DNS server for Matter over Wi-Fi (KRKNWK-18256). + * An issue with a memory leak in the deferred attribute persister (KRKNWK-18221). + +Wi-Fi +----- + +* Added support for band selection in shell and API. + +* Fixed: + + * An issue with QSPI initialization on a custom board with nRF5340 and nRF7002 (SHEL-2372). + * An issue where the channel setting is ignored in the connection request. + +Zephyr +====== + +The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``a768a05e6205e415564226543cee67559d15b736``. + +For a complete list of |NCS| specific commits and cherry-picked commits since v2.5.0, run the following command: + +.. code-block:: none + + git log --oneline manifest-rev ^v3.4.99-ncs1 diff --git a/doc/nrf/releases_and_maturity/software_maturity.rst b/doc/nrf/releases_and_maturity/software_maturity.rst index 728347907191..179f50b1b145 100644 --- a/doc/nrf/releases_and_maturity/software_maturity.rst +++ b/doc/nrf/releases_and_maturity/software_maturity.rst @@ -175,25 +175,31 @@ Protocol support The following table indicates the software maturity levels of the support for each :ref:`protocol `: -.. sml-table:: top_level - :insert-values: - [ - ( - "Zigbee", - "nRF52833", - "Experimental" - ), - ( - "Zigbee", - "nRF52840", - "Experimental" - ), - ( - "Zigbee", - "nRF5340", - "Experimental" - ) - ] ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| | nRF52810 | nRF52811 | nRF52820 | nRF52832 | nRF5283 | nRF52840 | nRF5340 | nRF9160 | nRF9161 | ++===============+===========+===========+===========+===========+==============+=====================+=====================+=====================+=====================+ +| **Bluetooth** | Supported | Supported | Supported | Supported | Supported | Supported | Supported | -- | -- | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **Bluetooth | -- | -- | -- | Supported | Supported | Supported | Supported | -- | -- | +| Mesh** | | | | | | | | | | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **HomeKit** | -- | -- | -- | -- | Supported | Supported | Supported | -- | -- | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **LTE** | -- | -- | -- | -- | -- | -- | -- | Supported | Supported | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **Matter** | -- | -- | -- | -- | -- | Supported | Supported | -- | -- | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **Sidewalk** | -- | -- | -- | -- | -- | Supported | Supported | -- | -- | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **Thread** | -- | -- | -- | -- | Supported | Supported | Supported | -- | -- | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **Wi-Fi** | -- | -- | -- | -- | -- | Supported\ :sup:`1` | Supported\ :sup:`2` | Supported\ :sup:`1` | Supported\ :sup:`1` | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ +| **Zigbee** | -- | -- | -- | -- | Experimental | Experimental | Experimental | -- | -- | ++---------------+-----------+-----------+-----------+-----------+--------------+---------------------+---------------------+---------------------+---------------------+ + +| [1]: Only with nRF7002 EK, nRF7002 EK in nRF7000 emulation mode or nRF7002 EK in nRF7001 emulation mode +| [2]: Only with nRF7002 DK, nRF7002 DK in nRF7001 emulation mode, nRF7002 EB, nRF7002 EK, nRF7002 EK in nRF7000 emulation mode or nRF7002 EK in nRF7001 emulation mode Amazon Sidewalk features support ******************************** @@ -220,7 +226,91 @@ The following table indicates the software maturity levels of the support for ea .. toggle:: - .. sml-table:: homekit + .. list-table:: + :widths: 20 10 10 10 10 10 10 10 10 10 + :header-rows: 1 + :align: center + + * - Feature + - nRF52810 + - nRF52811 + - nRF52820 + - nRF52832 + - nRF52833 + - nRF52840 + - nRF5340 + - nRF9160 + - nRF9161 + * - **HomeKit - OTA DFU over Bluetooth LE** + - -- + - -- + - -- + - -- + - -- + - Supported + - Supported + - -- + - -- + * - **HomeKit - OTA DFU over HomeKit** + - -- + - -- + - -- + - -- + - -- + - Supported + - Supported + - -- + - -- + * - **HomeKit commissioning over Bluetooth LE with NFC** + - -- + - -- + - -- + - -- + - Supported + - Supported + - Supported + - -- + - -- + * - **HomeKit commissioning over Bluetooth LE with QR code** + - -- + - -- + - -- + - -- + - Supported + - Supported + - Supported + - -- + - -- + * - **HomeKit over Bluetooth LE** + - -- + - -- + - -- + - -- + - Supported + - Supported + - Supported + - -- + - -- + * - **HomeKit over Thread FTD** + - -- + - -- + - -- + - -- + - -- + - Supported + - Supported + - -- + - -- + * - **HomeKit over Thread MTD SED** + - -- + - -- + - -- + - -- + - -- + - Supported + - Supported + - -- + - -- Thread features support *********************** diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt index f3ebc9d65e2f..5c8f1675f96e 100644 --- a/doc/nrf/shortcuts.txt +++ b/doc/nrf/shortcuts.txt @@ -1,8 +1,8 @@ .. |NCS| replace:: nRF Connect SDK -.. |release| replace:: v2.5.1 -.. |release_tt| replace:: ``v2.5.1`` -.. |release_number_tt| replace:: ``2.5.1`` +.. |release| replace:: v2.5.2 +.. |release_tt| replace:: ``v2.5.2`` +.. |release_number_tt| replace:: ``2.5.2`` .. ### Config shortcuts diff --git a/doc/nrfxlib/conf.py b/doc/nrfxlib/conf.py index 017cc0b68c8e..d46cdf741a1b 100644 --- a/doc/nrfxlib/conf.py +++ b/doc/nrfxlib/conf.py @@ -26,7 +26,7 @@ project = "nrfxlib" copyright = "2019-2023, Nordic Semiconductor" author = "Nordic Semiconductor" -version = release = "2.5.1" +version = release = "2.5.2" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) diff --git a/doc/versions.json b/doc/versions.json index 1c8f866af392..7a79d94bb409 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,4 +1,5 @@ [ + "2.5.2", "2.5.1", "2.5.0", "2.4.2",