Skip to content

Commit

Permalink
doc: Release notes for 2.9.0-nRF54H20-1
Browse files Browse the repository at this point in the history
Added release notes for 2.9.0-nRF54H20-1.
Added migration guide for 2.9.0-nRF54H20-1.
Added other release edits for 2.9.0-nRF54H20-1.

Signed-off-by: Francesco Domenico Servidio <[email protected]>
  • Loading branch information
FrancescoSer authored and b-gent committed Jan 15, 2025
1 parent 509fa66 commit f8c256f
Show file tree
Hide file tree
Showing 31 changed files with 117 additions and 67 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# General configuration --------------------------------------------------------

project = "nRF Connect SDK"
copyright = "2019-2024, Nordic Semiconductor"
copyright = "2019-2025, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = os.environ.get("DOCSET_VERSION")

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: 2.9.0-nRF54H20-rc1
revision: 2.9.0-nRF54H20-1
import: true
self:
path: application
Expand All @@ -189,7 +189,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: 2.9.0-nRF54H20-rc1
revision: 2.9.0-nRF54H20-1
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
10 changes: 5 additions & 5 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@
.. _`nRF Connect SDK latest documentation`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html

.. _`known issues page on the main branch`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html
.. _`known issues for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0-nRF54H20-rc1
.. _`known issues for nRF Connect SDK v2.9.0-nRF54H20-1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0-nRF54H20-1
.. _`known issues for nRF Connect SDK v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0
.. _`known issues for nRF Connect SDK v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-8-0
.. _`known issues for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-7-0
Expand Down Expand Up @@ -478,7 +478,7 @@

.. _`nRF socket options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/nrf_modem/doc/sockets.html

.. _`Repositories and revisions for v2.9.0-nRF54H20-rc1`: https://docs.nordicsemi.com/bundle/ncs-2.9.0-nrf54h20-rc1/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.9.0-nRF54H20-1`: https://docs.nordicsemi.com/bundle/ncs-2.9.0-nRF54H20-1/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.7.99-cs2`: https://docs.nordicsemi.com/bundle/ncs-2.7.99-cs2/page/nrf/releases_and_maturity/repository_revisions.html
Expand Down Expand Up @@ -570,7 +570,7 @@
.. _`LwM2M carrier library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html

.. _`Migration guide for nRF Connect SDK v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_3.0.html
.. _`Migration guide for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20-rc1.html
.. _`Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1.html
.. _`Migration guide for nRF Connect SDK v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.html
.. _`Migration guide for nRF Connect SDK v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.8.html
.. _`Migration guide for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.7.html
Expand Down Expand Up @@ -1560,8 +1560,8 @@

.. ### Source: files.nordicsemi.com

.. _`Twister test report for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-rc1/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-rc1/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
.. _`Twister test report for nRF Connect SDK v2.9.0-nRF54H20-1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-1/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v2.9.0-nRF54H20-1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-1/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
.. _`Twister test report for nRF Connect SDK v2.9.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v2.9.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
.. _`Twister test report for nRF Connect SDK v2.8.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.8.0/test-report/twister_test_results_report.html?isNativeBrowsing=true
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/protocols/matter/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ For a full list of |NCS| and Matter versions, view the following table:
+--------------------------+-----------------------------------------------------+------------------------+
| nRF Connect SDK version | Matter specification version | Matter SDK version |
+==========================+=====================================================+========================+
| v2.9.99 (latest) | :ref:`1.4.0 <ug_matter_overview_dev_model_support>` | 1.4.0.0 |
| |release| | :ref:`1.4.0 <ug_matter_overview_dev_model_support>` | 1.4.0.0 |
+--------------------------+ | |
| |release| | | |
| v2.9.0-nRF54H20-1 | | |
+--------------------------+ | |
| v2.9.0 | | |
+--------------------------+-----------------------------------------------------+------------------------+
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/releases_and_maturity/abi_compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The following table illustrates ABI compatibility between different versions of

* - |NCS| versions
- Compatible nRF54H20 SoC binaries version
* - |NCS| v2.9.0-nRF54H20
* - |NCS| v2.9.0-nRF54H20-1
- `nRF54H20 SoC Binaries v0.8.0`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
* - |NCS| v2.9.0
- `nRF54H20 SoC Binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs3_to_2_6_99_cs2_app:

Migrate your application to |NCS| v2.6.99_cs2 (for v2.4.99-cs3 users)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs3_to_2_6_99_cs2_env:

Update your development environment for |NCS| v2.6.99_cs2 (for v2.4.99-cs3 users)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_2.0.0_migration:

Migration notes for |NCS| v2.0.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs3_to_2_6_99_cs2:

Migration notes for |NCS| v2.6.99_cs2 for v2.4.99-cs3 users
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.5:

Migration guide for |NCS| v2.5.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.6:

Migration guide for |NCS| v2.6.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.7:

Migration guide for |NCS| v2.7.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.8:

Migration guide for |NCS| v2.8.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
.. _migration_2.9.0-nrf54h20-rc1:
:orphan:

Migration guide for |NCS| v2.9.0-nRF54H20-rc1
#############################################
.. _migration_2.9.0-nrf54h20-1:

Migration guide for |NCS| v2.9.0-nRF54H20-1
###########################################

.. contents::
:local:
:depth: 3

This document describes the changes required or recommended when migrating your nRF54H20 application from the |NCS| v2.8.0 to the |NCS| v2.9.0-nRF54H20-rc1.
This document describes the changes required or recommended when migrating your nRF54H20 application from the |NCS| v2.8.0 to the |NCS| v2.9.0-nRF54H20-1.

.. HOWTO
Expand All @@ -21,7 +23,7 @@ This document describes the changes required or recommended when migrating your
* Change1 and description
* Change2 and description
.. _migration_2.9.0-nrf54h20-rc1_required:
.. _migration_2.9.0-nrf54h20-1_required:

Required changes
****************
Expand All @@ -38,7 +40,7 @@ DK compatibility

.. toggle::

* The |NCS| v2.9.0-nRF54H20-rc1 is compatible only with the Engineering C - v0.9.0 and later revisions of the nRF54H20 DK, PCA10175.
* The |NCS| v2.9.0-nRF54H20 is compatible only with the Engineering C - v0.9.0 and later revisions of the nRF54H20 DK, PCA10175.
Check the version number on your DK's sticker to verify its compatibility with the |NCS|.

Dependencies
Expand Down Expand Up @@ -165,3 +167,15 @@ nrfutil suit
nrfutil install suit=0.9.0 --force

For more information, consult the `nRF Util`_ documentation.

nrf-regtool
+++++++++++

.. toggle::

* ``nrf-regtool`` has been updated to version 8.1.2.

1. Open nRF Connect for Desktop, navigate to the Toolchain Manager, select the v2.9.0-nRF54H20-1 toolchain, and click the :guilabel:`Open terminal` button.
#. In the terminal window, install ``nrf-regtool`` version 8.1.2 as follows::

pip install nrf-regtool==8.1.2
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.9:

Migration guide for |NCS| v2.9.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_3.0:

Migration guide for |NCS| v3.0.0 (Working draft)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7:

Migration notes for |NCS| v2.7.0 and the nRF54H20 DK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs1:

Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs2:

Migration notes for |NCS| v2.7.99-cs2 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _hwmv1_to_v2_migration:

Migrating to the current hardware model
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _child_parent_to_sysbuild_migration:

Migrating from multi-image builds to sysbuild
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs3_to_to_2_7_app:

Migrate your application for the nRF54H20 DK to |NCS| v2.7.0 (for v2.4.99-cs3 users)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2_6_99_cs2_to_2_7_app:

Migrate your application for the nRF54H20 DK to |NCS| v2.7.0 (for v2.6.99-cs2 users)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs2_to_2_7_env:

Migrate your development environment to |NCS| v2.7.0 (for v2.6.99-cs2 users)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _transition_cs3_to_2_7_env:

Transition your development environment to |NCS| v2.7.0 (for v2.4.99-cs3 users)
Expand Down
21 changes: 15 additions & 6 deletions doc/nrf/releases_and_maturity/migration_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,19 @@ Migration guides are also provided for major functionality updates.
.. note::
|migration_contact_devzone|

.. toctree::
:maxdepth: 1
:glob:
:reversed:
:caption: Subpages:
* `Migrating from multi-image builds to sysbuild`_
* `Migrating to the current hardware model`_
* `Migration guide for nRF Connect SDK v2.9.0`_
* `Migration guide for nRF Connect SDK v2.8.0`_
* `Migration guide for nRF Connect SDK v2.7.0`_
* `Migration guide for nRF Connect SDK v2.6.0`_
* `Migration guide for nRF Connect SDK v2.5.0`_
* `Migration guide for nRF Connect SDK v2.0.0`_

migration/*
For nRF54H20-exclusive releases:

* `Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1`_
* `Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`_
* `Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`_
* `Migration notes for nRF Connect SDK v2.7.0 for nRF54H20 DK users`_
* `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_
6 changes: 2 additions & 4 deletions doc/nrf/releases_and_maturity/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,16 @@ This page is included only in the latest documentation, because it might contain

.. note::
A "99" at the end of the version number of this documentation indicates continuous updates on the main branch since the previous major.minor release.
When looking at this latest documentation, be aware of the following aspects:
When looking at this latest documentation, be aware of the following aspect:

* Changes between releases are tracked on the :ref:`ncs_release_notes_changelog` page, but the main branch might contain additional changes that are not listed on that page.
* The release note pages that are available in the latest documentation might differ slightly from the release notes that were included in the respective |NCS| release at its release date.
Therefore, to see the official version of the release notes for a specific |NCS| release, switch to the documentation for the corresponding |NCS| version using the selector in the upper left corner.

.. toctree::
:maxdepth: 1
:caption: Subpages:

releases/release-notes-changelog
releases/release-notes-2.9.0-nrf54h20-rc1
releases/release-notes-2.9.0-nRF54H20-1
releases/release-notes-2.9.0
releases/release-notes-2.8.0
releases/release-notes-2.7.99-cs2
Expand Down
Loading

0 comments on commit f8c256f

Please sign in to comment.