Skip to content

Commit

Permalink
doc: doc updates for release 2.7.99-cs2
Browse files Browse the repository at this point in the history
Release notes, migration guides, and related changes.

Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
  • Loading branch information
b-gent committed Sep 24, 2024
1 parent cf2cc23 commit 1af4165
Show file tree
Hide file tree
Showing 20 changed files with 133 additions and 14 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.7.99"
version = release = "2.7.99-cs2"

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: 2.7.0
revision: 2.7.99-cs2
import: true
self:
path: application
Expand All @@ -189,7 +189,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: 2.7.0
revision: 2.7.99-cs2
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,7 @@

.. _`nRF socket options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/nrf_modem/doc/sockets.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
.. _`Repositories and revisions for v2.7.99-cs1`: https://docs.nordicsemi.com/bundle/ncs-2.7.99-cs1/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.6.2`: https://docs.nordicsemi.com/bundle/ncs-2.6.2/page/nrf/releases_and_maturity/repository_revisions.html
Expand Down Expand Up @@ -554,6 +555,7 @@
.. _`Migrating to the current hardware model`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_hwmv2.html


.. _`Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.html
.. _`Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.html
.. _`Migration notes for nRF Connect SDK v2.7.0 for nRF54H20 DK users`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.html
.. _`Transition your development environment to nRF Connect SDK v2.7.0 for v2.4.99-cs3 users`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.html
Expand Down
1 change: 0 additions & 1 deletion doc/nrf/releases_and_maturity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ If an issue is found in a release after it has taken place, those issues are lis
releases_and_maturity/repository_revisions
releases_and_maturity/software_maturity
releases_and_maturity/abi_compatibility
releases_and_maturity/known_issues
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
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 (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
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
18 changes: 12 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,16 @@ 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.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 customer sampling participants:

* `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`_
5 changes: 2 additions & 3 deletions doc/nrf/releases_and_maturity/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +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.7.99-cs2
releases/release-notes-2.7.99-cs1
releases/release-notes-2.7.0
releases/release-notes-2.6.2
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
.. _ncs_release_notes_2799_cs2:

|NCS| v2.7.99-cs2 Release Notes
###############################

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

|NCS| v2.7.99-cs2 is a **customer sampling** release, tailored exclusively for participants in the nRF54H20 SoC customer sampling program.
Do not use this release of |NCS| if you are not participating in the program.

The release is not part of the regular release cycle and is specifically designed to support early adopters working with the nRF54H20 SoC.
It is intended to provide early access to the latest developments for nRF54H20 SoC, enabling participants to experiment with new features and provide feedback.

The scope of this release is intentionally narrow, concentrating solely on the nRF54H20 DK.
You can use the latest stable release of |NCS| to work with other boards.

All functionality related to nRF54H20 SoC is considered experimental.

Highlights
**********

Added the following features as experimental:

ADD

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

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

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

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

Migration notes
***************

See the `Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`_ for the changes required or recommended when migrating your environment to the |NCS| v2.7.99-cs2.

Changelog
*********

The following sections provide detailed lists of changes by component.

Zephyr
======

.. NOTE TO MAINTAINERS: All the Zephyr commits in the below git commands must be handled specially after each upmerge and each nRF Connect SDK release.
The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``28b6861211d2d9f54411ff60357a42d84a253600``, with some |NCS| specific additions.

* Added:



For the list of upstream Zephyr commits (not including cherry-picked commits) incorporated into nRF Connect SDK since the most recent release, run the following command from the :file:`ncs/zephyr` repository (after running ``west update``):

.. code-block:: none
git log --oneline 28b6861211 ^25e90e7bb0
For the list of |NCS| specific commits, including commits cherry-picked from upstream, run:

.. code-block:: none
git log --oneline manifest-rev ^28b6861211
The current |NCS| main branch is based on revision ``28b6861211`` of Zephyr.

.. note::
For possible breaking changes and changes between the latest Zephyr release and the current Zephyr version, refer to the :ref:`Zephyr release notes <zephyr_release_notes>`.

Documentation
=============

* Added:

* :ref:`migration_nrf54h20_to_2.7.99-cs2`.
* :ref:`abi_compatibility` page.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_release_notes_changelog:

Changelog for |NCS| v2.7.99
Expand Down
2 changes: 1 addition & 1 deletion doc/versions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
"2.7.99",
"2.7.99-cs2",
"2.7.99-cs1",
"2.7.0",
"2.6.2",
Expand Down

0 comments on commit 1af4165

Please sign in to comment.