From 8dc6afc121bc3da1351f4cc71b34e57afab52e60 Mon Sep 17 00:00:00 2001 From: Uma Praseeda Date: Wed, 21 Aug 2024 09:34:52 +0200 Subject: [PATCH] doc: Update docs for 2.4.4 release Update docs for 2.4.4 release Signed-off-by: Uma Praseeda --- doc/nrf/conf.py | 2 +- doc/nrf/developing/adding_code.rst | 4 +- doc/nrf/links.txt | 4 + doc/nrf/release_notes.rst | 1 + doc/nrf/releases/release-notes-2.4.4.rst | 98 ++++++++++++++++++++++++ doc/nrf/shortcuts.txt | 6 +- doc/nrfxlib/conf.py | 2 +- doc/versions.json | 1 + 8 files changed, 111 insertions(+), 7 deletions(-) create mode 100644 doc/nrf/releases/release-notes-2.4.4.rst diff --git a/doc/nrf/conf.py b/doc/nrf/conf.py index 77d5dd9b4108..cbf5aeedba6f 100644 --- a/doc/nrf/conf.py +++ b/doc/nrf/conf.py @@ -27,7 +27,7 @@ project = "nRF Connect SDK" copyright = "2019-2023, Nordic Semiconductor" author = "Nordic Semiconductor" -version = release = "2.4.3" +version = release = "2.4.4" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) diff --git a/doc/nrf/developing/adding_code.rst b/doc/nrf/developing/adding_code.rst index 813dae3e7826..6490923a0118 100644 --- a/doc/nrf/developing/adding_code.rst +++ b/doc/nrf/developing/adding_code.rst @@ -138,7 +138,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.4.3 + revision: v2.4.4 import: true self: path: application @@ -165,7 +165,7 @@ For example: projects: - name: nrf remote: ncs - revision: v2.4.3 + revision: v2.4.4 import: true # Example for how to override a repository in the nRF Connect SDK with your own: - name: mcuboot diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index a4e38bab13b1..81b49ee00f44 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -216,6 +216,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.4.4`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-4-4 .. _`known issues for nRF Connect SDK v2.4.3`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-4-3 .. _`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 .. _`known issues for nRF Connect SDK v2.4.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-4-1 @@ -293,6 +294,7 @@ .. _`TF-M documentation`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/tfm/index.html .. _`TF-M secure partition integration guide`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/tfm/integration_guide/services/tfm_secure_partition_addition.html +.. _`Repositories and revisions for v2.4.4`: https://docs.nordicsemi.com/bundle/ncs-2.4.4/page/nrf/releases_and_maturity/repository_revisions.html .. _`Repositories and revisions for v2.4.3`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.3/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 .. _`Repositories and revisions for v2.4.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.1/nrf/introduction.html#ncs-repository-revisions @@ -311,6 +313,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.4.4`: https://docs.nordicsemi.com/bundle/ncs-2.4.4/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog .. _`Modem library changelog for v2.4.3`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.3/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 .. _`Modem library changelog for v2.4.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.1/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog @@ -329,6 +332,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.4.4`: https://docs.nordicsemi.com/bundle/ncs-2.4.4/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog .. _`LwM2M carrier library changelog for v2.4.3`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.3/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 .. _`LwM2M carrier library changelog for v2.4.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.1/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog diff --git a/doc/nrf/release_notes.rst b/doc/nrf/release_notes.rst index c59549331d13..73d110fabd7f 100644 --- a/doc/nrf/release_notes.rst +++ b/doc/nrf/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.4.4 releases/release-notes-2.4.3 releases/release-notes-2.4.2 releases/release-notes-2.4.1 diff --git a/doc/nrf/releases/release-notes-2.4.4.rst b/doc/nrf/releases/release-notes-2.4.4.rst new file mode 100644 index 000000000000..cb2ff50e90b3 --- /dev/null +++ b/doc/nrf/releases/release-notes-2.4.4.rst @@ -0,0 +1,98 @@ +.. _ncs_release_notes_244: + +|NCS| v2.4.4 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.4.0 `, :ref:`nRF Connect SDK v2.4.1 `, :ref:`nRF Connect SDK v2.4.2 ` and :ref:`nRF Connect SDK v2.4.3 `. +The changes have an effect on Matter and Bluetooth®. + +See :ref:`ncs_release_notes_244_changelog` for the complete list of changes. + +Release tag +*********** + +The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.4.4**. +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.4.4`_. + +IDE and tool support +******************** + +`nRF Connect for Visual Studio Code extension `_ is the only officially supported IDE for |NCS| v2.4.4. +SEGGER Embedded Studio Nordic Edition is no longer tested or recommended for new projects. + +:ref:`Toolchain Manager `, 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.4.4`_ for the list of issues valid for the latest release. + +.. _ncs_release_notes_244_changelog: + +Changelog +********* + +Libraries +========= + +This section provides detailed lists of changes by :ref:`library `. + +Other libraries +--------------- + +* Added :ref:`network_core_monitor` library for monitoring the status of the nRF5340 processor's network core. + +Zephyr +====== + +The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``4bbd91a9083a588002d4397577863e0c54ba7038``. +It also contains some |NCS| specific additions and commits cherry-picked from the upstream Zephyr repository including the following one: + +* Added workarounds in sdk-zephyr for the Anomaly 168 and the Anomaly 165 that are affecting the nRF5340 SoC. + +For a complete list of |NCS| specific commits and cherry-picked commits since v2.4.0, run the following command: + +.. code-block:: none + + git log --oneline manifest-rev ^v3.3.99-ncs2 diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt index fa6be127d112..47e5612f8398 100644 --- a/doc/nrf/shortcuts.txt +++ b/doc/nrf/shortcuts.txt @@ -1,8 +1,8 @@ .. |NCS| replace:: nRF Connect SDK -.. |release| replace:: v2.4.3 -.. |release_tt| replace:: ``v2.4.3`` -.. |release_number_tt| replace:: ``2.4.3`` +.. |release| replace:: v2.4.4 +.. |release_tt| replace:: ``v2.4.4`` +.. |release_number_tt| replace:: ``2.4.4`` .. ### Config shortcuts diff --git a/doc/nrfxlib/conf.py b/doc/nrfxlib/conf.py index 226c880d9cbf..ae22fee15cfd 100644 --- a/doc/nrfxlib/conf.py +++ b/doc/nrfxlib/conf.py @@ -27,7 +27,7 @@ project = "nrfxlib" copyright = "2019-2023, Nordic Semiconductor" author = "Nordic Semiconductor" -version = release = "2.4.3" +version = release = "2.4.4" 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 70bdb8fd77f6..c8d4b68e3283 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,4 +1,5 @@ [ + "2.4.4", "2.4.3", "2.4.2", "2.4.1",