Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update docs for 2.4.4 release #16940

Merged
merged 1 commit into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/nrf/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2023 Nordic Semiconductor
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#
Expand All @@ -25,9 +25,9 @@
# General configuration --------------------------------------------------------

project = "nRF Connect SDK"
copyright = "2019-2023, Nordic Semiconductor"
copyright = "2019-2024, 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"))
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/developing/adding_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
103 changes: 103 additions & 0 deletions doc/nrf/releases/release-notes-2.4.4.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
.. _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 <ncs_release_notes_240>`, :ref:`nRF Connect SDK v2.4.1 <ncs_release_notes_241>`, :ref:`nRF Connect SDK v2.4.2 <ncs_release_notes_242>` and :ref:`nRF Connect SDK v2.4.3 <ncs_release_notes_243>`.
The changes have an effect on Matter and Bluetooth®.
umapraseeda marked this conversation as resolved.
Show resolved Hide resolved

This release adds workaround for Anomaly 165 and Anomaly 168 that is affecting the nRF5340 SoC.
It also adds the :ref:`network_core_monitor` library for monitoring the status of the nRF5340 processor's network core.

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 <nRF Connect for Visual Studio Code_>`_ 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 <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 <Modem library changelog for v2.4.4_>`_
* - LwM2M carrier library
- `Changelog <LwM2M carrier library changelog for v2.4.4_>`_

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
*********

The following sections provide detailed lists of changes by component.

umapraseeda marked this conversation as resolved.
Show resolved Hide resolved
Libraries
=========

This section provides detailed lists of changes by :ref:`library <libraries>`.

Other libraries
---------------

umapraseeda marked this conversation as resolved.
Show resolved Hide resolved
* 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 ``c0aa4d27d3f2767e88c6c8c4634425086156f7f5``.
It also contains some |NCS| specific additions and commits cherry-picked from the upstream Zephyr repository including the following one:

umapraseeda marked this conversation as resolved.
Show resolved Hide resolved
* 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:
umapraseeda marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: none

git log --oneline manifest-rev ^v3.3.99-ncs1-3
6 changes: 3 additions & 3 deletions doc/nrf/shortcuts.txt
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions doc/nrfxlib/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2023 Nordic Semiconductor
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#
Expand All @@ -25,9 +25,9 @@
# General configuration --------------------------------------------------------

project = "nrfxlib"
copyright = "2019-2023, Nordic Semiconductor"
copyright = "2019-2024, 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"))
Expand Down
1 change: 1 addition & 0 deletions doc/versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[
"2.4.4",
"2.4.3",
"2.4.2",
"2.4.1",
Expand Down
Loading