Skip to content

Commit

Permalink
doc: update docs for 2.4.3
Browse files Browse the repository at this point in the history
Updating and creating release-related doc files.

Signed-off-by: Pekka Niskanen <pekka.niskanen@nordicsemi.no>
  • Loading branch information
peknis authored and cvinayak committed Jan 30, 2024
1 parent cbfa923 commit 9227520
Show file tree
Hide file tree
Showing 10 changed files with 223 additions and 3,874 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
project = "nRF Connect SDK"
copyright = "2019-2023, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = "2.4.2"
version = release = "2.4.3"

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.2
revision: v2.4.3
import: true
self:
path: application
Expand All @@ -165,7 +165,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: v2.4.2
revision: v2.4.3
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
3,872 changes: 7 additions & 3,865 deletions doc/nrf/known_issues.rst

Large diffs are not rendered by default.

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.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
.. _`known issues for nRF Connect SDK v2.4.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/known_issues.html?v=v2-4-0
Expand Down Expand Up @@ -292,6 +293,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.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
.. _`Repositories and revisions for v2.4.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.0/nrf/introduction.html#ncs-repository-revisions
Expand All @@ -309,6 +311,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.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
.. _`Modem library changelog for v2.4.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
Expand All @@ -326,6 +329,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.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
.. _`LwM2M carrier library changelog for v2.4.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.0/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.3
releases/release-notes-2.4.2
releases/release-notes-2.4.1
releases/release-notes-2.4.0
Expand Down
98 changes: 98 additions & 0 deletions doc/nrf/releases/release-notes-2.4.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
.. _ncs_release_notes_243:

|NCS| v2.4.3 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>`, and :ref:`nRF Connect SDK v2.4.2 <ncs_release_notes_242>`.
The changes have an effect on Bluetooth Mesh.

See :ref:`ncs_release_notes_243_changelog` for the complete list of changes.

Release tag
***********

The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.4.3**.
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.3`_.

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.3.
SEGGER Embedded Studio Nordic Edition is no longer tested or recommended for new projects.

: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 <Modem library changelog for v2.4.3_>`_
* - LwM2M carrier library
- `Changelog <LwM2M carrier library changelog for v2.4.3_>`_

Known issues
************

Known issues are only tracked for the latest official release.
See `known issues for nRF Connect SDK v2.4.3`_ for the list of issues valid for the latest release.

.. _ncs_release_notes_243_changelog:

Changelog
*********

Protocols
=========

Bluetooth
---------

Fixed an issue that affects SoftDevice Controller when running in continuous scan mode.
This mode of operation is typical, but not limited to Bluetooth Mesh.
The controller may end up in an irresponsive state due to this issue.
See the :ref:`changelog <nrfxlib:softdevice_controller_changelog>` of the SoftDevice Controller library for details.

The following sections provide detailed lists of changes by component.

Zephyr
======

The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``4bbd91a9083a588002d4397577863e0c54ba7038``.

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-ncs1
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.2
.. |release_tt| replace:: ``v2.4.2``
.. |release_number_tt| replace:: ``2.4.2``
.. |release| replace:: v2.4.3
.. |release_tt| replace:: ``v2.4.3``
.. |release_number_tt| replace:: ``2.4.3``

.. ### Config shortcuts

Expand Down
107 changes: 105 additions & 2 deletions doc/nrf/software_maturity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,26 @@ Protocol support

The following table indicates the software maturity levels of the support for each :ref:`protocol <protocols>`:

.. sml-table:: top_level
+---------------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
| | nRF52810 | nRF52811 | nRF52820 | nRF52832 | nRF52833 | 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 | \- | \- |
+---------------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
| **Thread** | \- | \- | \- | \- | Supported | Supported | Supported | \- | \- |
+---------------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
| **Wi-Fi** | \- | \- | \- | \- | \- | \- | \- | \- | \- |
+---------------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
| **Zigbee** | \- | \- | \- | \- | Supported | Supported | Supported | \- | \- |
+---------------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+

Bluetooth features support
**************************
Expand All @@ -191,7 +210,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
***********************
Expand Down
2 changes: 1 addition & 1 deletion doc/nrfxlib/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
project = "nrfxlib"
copyright = "2019-2023, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = "2.4.2"
version = release = "2.4.3"

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.3",
"2.4.2",
"2.4.1",
"2.4.0",
Expand Down

0 comments on commit 9227520

Please sign in to comment.