From 17389a6ea531d4cd0be11a06ff8b8f0c08143495 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc Date: Fri, 6 Sep 2024 08:54:58 +0200 Subject: [PATCH] doc: OS support: update table Updated table with input received from stakeholders. Updated definitions based on receved feedback. NCSDK-29043. Signed-off-by: Grzegorz Ferenc --- doc/nrf/installation/install_ncs.rst | 6 +- doc/nrf/installation/recommended_versions.rst | 85 ++++--------------- doc/nrf/links.txt | 9 +- .../releases/release-notes-changelog.rst | 13 ++- 4 files changed, 34 insertions(+), 79 deletions(-) diff --git a/doc/nrf/installation/install_ncs.rst b/doc/nrf/installation/install_ncs.rst index df80b2de93f..6756a60da69 100644 --- a/doc/nrf/installation/install_ncs.rst +++ b/doc/nrf/installation/install_ncs.rst @@ -25,14 +25,12 @@ This includes everything that is required by Zephyr's :ref:`zephyr:getting_start Update operating system *********************** -Before you start setting up the toolchain, install available updates for your operating system. +Before you start setting up the toolchain, install available updates for your :ref:`operating system `. .. include:: ./recommended_versions.rst :start-after: os_table_start :end-before: os_table_end -See :ref:`supported_OS` for more information about the tier definitions. - .. _installing_vsc: .. rst-class:: numbered-step @@ -59,6 +57,8 @@ Depending on your preferred development environment, install the following requi * The latest version of `nRF Util development tool`_, a unified command line utility for Nordic products. .. note:: + nRF Util has its own `operating system requirements `_. + After downloading the nRF Util executable, move it to a directory that is in the system :envvar:`PATH`. On macOS and Linux, the downloaded file also needs to be given execute permission by typing `chmod +x nrfutil` or by checking the checkbox in the file properties. diff --git a/doc/nrf/installation/recommended_versions.rst b/doc/nrf/installation/recommended_versions.rst index 1a94b9f27de..e9556f16f3c 100644 --- a/doc/nrf/installation/recommended_versions.rst +++ b/doc/nrf/installation/recommended_versions.rst @@ -18,79 +18,30 @@ Supported operating systems *************************** The |NCS| supports Microsoft Windows, Linux, and macOS for development. -The following table shows the operating system versions that support the |NCS| tools: + +The following tables lists the support levels for the |NCS| firmware. .. os_table_start .. list-table:: - :header-rows: 1 - - * - Operating System - - x86 - - x64 - - ARM64 - * - `Windows 11`_ - - Tier 3 - - Tier 3 - - Not supported - * - `Windows 10`_ - - Tier 3 - - Tier 1 - - Not supported - * - `Linux - Ubuntu 22.04 LTS`_ - - Not supported - - Tier 1 - - Not supported - * - `Linux - Ubuntu 20.04 LTS`_ - - Not supported - - Tier 2 - - Not supported - * - `macOS 14`_ - - Not applicable - - Tier 3 - - Tier 3 - * - `macOS 13`_ - - Not applicable - - Tier 1 - - Tier 1 - * - `macOS 12`_ - - Not applicable - - Tier 3 - - Tier 3 - * - `macOS 11`_ - - Not applicable - - Tier 2 - - Tier 2 - * - `macOS 10.15`_ - - Not applicable - - Tier 3 - - Not supported + :header-rows: 1 + + * - Operating System + - x64 + - ARM64 + * - `Windows 10`_ + - Built and tested with :ref:`Twister `. + - Not supported. + * - `Linux - Ubuntu 22.04 LTS`_ + - Built and tested with :ref:`Twister `. Comprehensive testing with Nordic Semicondutor hardware. + - Not supported. + * - `macOS 14`_ + - Built and tested with :ref:`Twister `. + - Only toolchain provided. .. os_table_end -Tier definitions - The table uses several tier definitions to categorize the level of operating system support: - - .. toggle:: Support levels - - Tier 1 - The |NCS| tools will always work. - The automated build and automated testing ensure that the |NCS| tools build and successfully complete tests after each change. - - Tier 2 - The |NCS| tools will always build. - The automated build ensures that the |NCS| tools build successfully after each change. - There is no guarantee that a build will work because the automation tests do not always run. - - Tier 3 - The |NCS| tools are supported by design, but are not built or tested after each change. - Therefore, the application may or may not work. - - Not supported - The |NCS| tools do not work, but it may be supported in the future. - - Not applicable - The specified architecture is not supported for the respective operating system. +For building, Twister uses definitions in :file:`sample.yml` for the default configuration for the given sample or application. Zephyr features only available on Linux There are some Zephyr features that are currently only available on Linux, including: @@ -379,7 +330,7 @@ nRF Util The `nRF Util development tool`_ is a unified command line utility for Nordic products. Its functionality is provided through installable and upgradeable commands that are served on a central package registry on the Internet. -The utility follows its own release cycle. +The utility follows its own release cycle and has its own `operating system requirements `_. Use the latest available release for development. nRF Util provides |NCS| toolchain packages for each |NCS| release through the ``toolchain-manager`` command. diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 08b0e185af1..c3191dbe191 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -598,7 +598,6 @@ .. _`nRF Connect Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html .. _`Connecting using Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/connecting.html .. _`Serial Terminal configuration`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/configuration.html -.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html .. _`nRF Connect Bluetooth Low Energy`: https://docs.nordicsemi.com/bundle/nrf-connect-ble/page/index.html .. _`Cellular Monitor`: https://docs.nordicsemi.com/bundle/nrf-connect-cellularmonitor/page/index.html .. _`nPM PowerUP`: https://docs.nordicsemi.com/bundle/nrf-connect-npm/page/index.html @@ -613,8 +612,6 @@ .. _`Programming the nRF52840 Dongle`: .. _`Programming a Development Kit`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_dk.html -.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html - .. _`nRF Thread Topology Monitor`: https://docs.nordicsemi.com/bundle/ug_nrf_ttm/page/UG/nrf_ttm/ttm_introduction.html .. _`nRF Sniffer for 802.15.4`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/intro_802154.html .. _`Configuring Wireshark for Zigbee`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/configuring_sniffer_802154_zigbee.html @@ -810,6 +807,7 @@ .. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html#available-subcommands .. _`Recovering the device`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_recovery.html .. _`nrfutil-trace`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/CHANGELOG.html +.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html .. _`anomaly 19`: https://docs.nordicsemi.com/bundle/errata_nRF5340_EngA/page/ERR/nRF5340/EngineeringA/latest/anomaly_340_19.html @@ -1397,16 +1395,15 @@ .. ### Source: ubuntu.com +.. _`Linux - Ubuntu 24.04 LTS`: https://releases.ubuntu.com/24.04/ .. _`Linux - Ubuntu 22.04 LTS`: https://releases.ubuntu.com/22.04/ .. _`Linux - Ubuntu 20.04 LTS`: https://releases.ubuntu.com/20.04/ .. ### Source: apple.com +.. _`macOS 15`: https://www.apple.com/macos/macos-sequoia/ .. _`macOS 14`: https://www.apple.com/macos/sonoma/ .. _`macOS 13`: https://www.apple.com/macos/ventura/ -.. _`macOS 12`: https://www.apple.com/macos/monterey/ -.. _`macOS 11`: https://support.apple.com/en-us/HT211896 -.. _`macOS 10.15`: https://support.apple.com/en-us/HT210642 .. _`Apple Notification Center Service Specification`: https://developer.apple.com/library/archive/documentation/CoreBluetooth/Reference/AppleNotificationCenterServiceSpecification/Introduction/Introduction.html .. _`Apple Media Service Reference`: https://developer.apple.com/library/ios/documentation/CoreBluetooth/Reference/AppleMediaService_Reference/Introduction/Introduction.html diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index f86e0787548..08986661b38 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -30,11 +30,18 @@ Changelog The following sections provide detailed lists of changes by component. -IDE, and tool support -===================== +IDE, OS, and tool support +========================= * Added explicit mention of the :ref:`requirements_jlink` being required in the :ref:`installing_vsc` section of the installation page. -* Updated the required `SEGGER J-Link`_ version to v7.94i. +* Updated: + + * The required `SEGGER J-Link`_ version to v7.94i. + * The :ref:`supported_OS` table on the :ref:`gs_recommended_versions` page: + + * Linux 24.04 and macOS 15 have been added to the list. + * macOS 10.15, macOS 11, macOS 12 have been removed from the list. + * Tier descriptions have been updated. Board support =============