Skip to content

Commit

Permalink
edits from Kari and Shantha
Browse files Browse the repository at this point in the history
Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer committed Oct 3, 2024
1 parent f9d1e0d commit b1d10f0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 104 deletions.
2 changes: 2 additions & 0 deletions doc/nrf/installation/install_ncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,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 <nRF Util_>`_.

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.

Expand Down
116 changes: 15 additions & 101 deletions doc/nrf/installation/recommended_versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,123 +18,37 @@ Supported operating systems
***************************

The |NCS| supports Microsoft Windows, Linux, and macOS for development.
The following tables list the support levels for tools and firmware.

Tier definitions
The tables use the following tier definitions to categorize the level of operating system support:

.. toggle:: Support levels

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

* - Tier level
- Building
- Testing
- Failures
* - **Tier 1 (recommended)**
- Successfully built.
- Successfully tested.
- 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 (n/a)**
- 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:

* BlueZ integration
* net-tools integration
* Native Port (native_posix)
* BabbleSim

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

The following table shows the operating system versions that support the |NCS| tools:
The following tables lists the support levels for the |NCS| firmware.
In this table, _built_ means building samples and application for platform integration as defined in :file:`sample.yml` for the default configuration for the given sample or application.

.. 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
- Built with software tests.
- 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`_
- n/a
- Tier 3
- Tier 3
- Built with software tests. Tested with Nordic Semicondutor hardware.
- Not supported.
* - `macOS 14`_
- n/a
- Tier 3
- Tier 3
* - `macOS 13`_
- n/a
- Tier 1
- Tier 1
- Built with software tests.
- Built **using `macOS 13`_**.

.. 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
Zephyr features only available on Linux
There are some Zephyr features that are currently only available on Linux, including:

* - 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
* BlueZ integration
* net-tools integration
* Native Port (native_posix)
* BabbleSim

.. _requirements_toolchain:

Expand Down Expand Up @@ -415,7 +329,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 <nRF Util_>`_.
Use the latest available release for development.

nRF Util provides |NCS| toolchain packages for each |NCS| release through the ``toolchain-manager`` command.
Expand Down
4 changes: 1 addition & 3 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit b1d10f0

Please sign in to comment.