Skip to content

Commit

Permalink
doc: update docs for 2.6.2
Browse files Browse the repository at this point in the history
Update docs for 2.6.2 release

Signed-off-by: Richa Pandey <[email protected]>
  • Loading branch information
richabp authored and rlubos committed Sep 16, 2024
1 parent 53b287a commit 8af1d70
Show file tree
Hide file tree
Showing 9 changed files with 149 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
project = "nRF Connect SDK"
copyright = "2019-2024, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = "2.6.1"
version = release = "2.6.2"

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/dev_model_and_contributions/adding_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.1
revision: v2.6.2
import: true
self:
path: application
Expand All @@ -189,7 +189,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: v2.6.1
revision: v2.6.2
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 @@ -246,6 +246,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.6.2`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-6-2
.. _`known issues for nRF Connect SDK v2.6.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-6-1
.. _`known issues for nRF Connect SDK v2.6.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-6-0
.. _`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
Expand Down Expand Up @@ -332,6 +333,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.6.2`: https://docs.nordicsemi.com/bundle/ncs-2.6.2/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.6.1`: https://docs.nordicsemi.com/bundle/ncs-2.6.1/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.6.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/releases_and_maturity/repository_revisions.html
.. _`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
Expand All @@ -355,6 +357,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.6.2`: https://docs.nordicsemi.com/bundle/ncs-2.6.2/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.6.1`: https://docs.nordicsemi.com/bundle/ncs-2.6.1/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.6.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`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
Expand All @@ -378,6 +381,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.6.2`: https://docs.nordicsemi.com/bundle/ncs-2.6.2/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.6.1`: https://docs.nordicsemi.com/bundle/ncs-2.6.1/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.6.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-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
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/releases_and_maturity/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.6.2
releases/release-notes-2.6.1
releases/release-notes-2.6.0
releases/release-notes-2.5.2
Expand Down
131 changes: 131 additions & 0 deletions doc/nrf/releases_and_maturity/releases/release-notes-2.6.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
.. _ncs_release_notes_262:

|NCS| v2.6.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.6.0 <ncs_release_notes_260>` and :ref:`nRF Connect SDK v2.6.1 <ncs_release_notes_261>`.
The changes affect Wi-Fi® stack.

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

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

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

IDE and tool support
********************

`nRF Connect extension for Visual Studio Code <nRF Connect for Visual Studio Code_>`_ is the recommended IDE for |NCS| v2.6.2.
See the :ref:`installation` section for more information about supported operating systems and toolchain.

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

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

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

.. _ncs_release_notes_262_changelog:

Changelog
*********

The following sections provide detailed lists of changes by component.

Protocols
=========

This section provides detailed lists of changes by :ref:`protocol <protocols>`.

Wi-Fi
-----

* Fixed a bug that causes TX EVM degradation.

Thread
------

* Fixed issue with high power consumption after parent loss.

Drivers
=======

This section provides detailed lists of changes by :ref:`driver <drivers>`.

Wi-Fi drivers
-------------

* Added:

* A new recovery feature through a watchdog timer with Kconfig-based timeout configuration to recover the nRF70 Series chip in case of any lockups.
* Wi-Fi interface de-initialization path clean-up and stabilization.
* A debug statistics and logging mechanism.

* Fixed interoperability issues with some access points through the following enhancements:

* Responding to any TIM fields instead of DTIM-only beacons.
* Dynamic TSF adjustments where the TSF is not properly aligned to the TBTT.
* QoS NULL-based packet retrieval through Kconfig, as well as a network management API.
* Support for keep alive frame.

Libraries
=========

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

Libraries for networking
------------------------

* Added the :ref:`lib_wifi_ready` library to facilitate application development.

Zephyr
======

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

For a complete list of |NCS| specific commits and cherry-picked commits since v2.6.0, run the following command:

.. code-block:: none
git log --oneline manifest-rev ^v3.5.99-ncs1
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Bluetooth Mesh
Matter
------

* Updated default MRP retry intervals for Thread devices to two seconds to reduce the number of spurious retransmissions in Thread networks.
|no_changes_yet_note|

Matter fork
+++++++++++
Expand All @@ -95,7 +95,7 @@ The following list summarizes the most important changes inherited from the upst
Thread
------

* Fixed ``otPlatCryptoPbkdf2GenerateKey`` API implementation to allow a fallback to legacy MbedTLS implementation instead of returning ``OT_ERROR_NOT_CAPABLE``.
|no_changes_yet_note|

Zigbee
------
Expand All @@ -120,7 +120,7 @@ nRF IEEE 802.15.4 radio driver
Wi-Fi
-----

* Fixed TX EVM regression.
|no_changes_yet_note|

Applications
============
Expand Down Expand Up @@ -295,7 +295,7 @@ This section provides detailed lists of changes by :ref:`driver <drivers>`.
Wi-Fi drivers
-------------

* Added a new feature to recover nRF70 chip.
|no_changes_yet_note|

Libraries
=========
Expand Down Expand Up @@ -335,7 +335,7 @@ Modem libraries
Libraries for networking
------------------------

* Added the :ref:`lib_wifi_ready` library.
|no_changes_yet_note|

Libraries for NFC
-----------------
Expand Down
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.6.1
.. |release_tt| replace:: ``v2.6.1``
.. |release_number_tt| replace:: ``2.6.1``
.. |release| replace:: v2.6.2
.. |release_tt| replace:: ``v2.6.2``
.. |release_number_tt| replace:: ``2.6.2``

.. ### Config shortcuts

Expand Down
2 changes: 1 addition & 1 deletion doc/nrfxlib/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
project = "nrfxlib"
copyright = "2019-2024, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = "2.6.1"
version = release = "2.6.2"

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.6.2",
"2.6.1",
"2.6.0",
"2.5.2",
Expand Down

0 comments on commit 8af1d70

Please sign in to comment.