Skip to content

Commit

Permalink
doc: OS support: update table
Browse files Browse the repository at this point in the history
Updated table with input received from stakeholders.
Updated definitions based on receved feedback.
NCSDK-29043.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer committed Sep 25, 2024
1 parent 719e592 commit a944eb0
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 73 deletions.
172 changes: 104 additions & 68 deletions doc/nrf/installation/recommended_versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,79 +18,41 @@ 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:

.. 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

.. os_table_end
The following tables list the support levels for tools and firmware.

Tier definitions
The table uses several tier definitions to categorize the level of operating system support:
The tables use the following 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.
.. list-table::
:header-rows: 1

* - Tier level
- Building
- Testing
- Failures
* - **Tier 1 (recommended)**
- Successfully executed based on risk.
- Successfully executed based on risk.
- Any failures block the release until they are fixed or a viable workaround is found.
* - **Tier 2**
- Building on this version is successfully executed at the :ref:`minimum recommended version of tools <requirements_toolchain>`.
- A manual sanity check is done based on risk.
- Failures do not block the release and are listed on the :ref:`known_issues` page.
Best effort is made to address them by the next official release.
* - **Tier 3**
- The |NCS| tools and firmware are supported by design, but are not built after each change.
- The |NCS| tools and firmware are supported by design, but are not tested after each change.
- The application firmware may or may not work.
* - **Not supported**
- The |NCS| tools and firmware do not work with this version.
- ---
- ---
* - *Not applicable**
- The specified architecture is not supported for the respective operating system.
- ---
- ---

Zephyr features only available on Linux
There are some Zephyr features that are currently only available on Linux, including:
Expand All @@ -100,6 +62,80 @@ Zephyr features only available on Linux
* Native Port (native_posix)
* BabbleSim

Supported operating systems for tools
=====================================

The following table shows the operating system versions that support the |NCS| tools:

.. 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 24.04 LTS`_
- Not supported
- Tier 2
- 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 15`_
- Not applicable
- Tier 3
- Tier 3
* - `macOS 14`_
- Not applicable
- Tier 3
- Tier 3
* - `macOS 13`_
- Not applicable
- Tier 1
- Tier 1

.. os_table_end
Supported operating systems for firmware
========================================

The following table shows the operating system versions that support the |NCS| firmware:

.. list-table::
:header-rows: 1

* - Operating System
- x86
- x64
- ARM64
* - `Windows 11`_
- Tier 3
- Tier 3
- Not supported
* - `Linux - Ubuntu 22.04 LTS`_
- Not supported
- Tier 1
- Not supported
* - `macOS 14`_
- Not applicable
- Tier 3
- Tier 3

.. _requirements_toolchain:

|NCS| toolchain
Expand Down
5 changes: 2 additions & 3 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1396,16 +1396,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-preview/
.. _`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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ 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 :ref:`supported_OS` table on the :ref:`gs_recommended_versions` page.

Build and configuration system
==============================
Expand Down

0 comments on commit a944eb0

Please sign in to comment.