Skip to content

Commit 136d689

Browse files
committed
doc: releases: Describe elf, dts, signed.bin, etc. artifacts
Add description of the build output files zipped into release artifacts. Signed-off-by: Tommi Rantanen <tommi.rantanen@nordicsemi.no>
1 parent c0d6b6e commit 136d689

2 files changed

Lines changed: 35 additions & 10 deletions

File tree

doc/links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
.. _`create_application_types_freestanding`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/create_application.html#create-application-types-freestanding
3434
.. _`sysbuild_enabled_ncs_configuring`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/config_and_build/sysbuild/sysbuild_configuring_west.html#sysbuild-enabled-ncs-configuring
3535
.. _`cmake_options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/config_and_build/cmake/index.html#cmake-options
36+
.. _`build output files`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/config_and_build/output_build_files.html
3637
.. _`Software maturity levels`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/software_maturity.html
3738

3839
.. _`ug_tfm_security_by_separation`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/security/tfm/processing_environments.html#ug-tfm-security-by-separation

doc/releases/release_artifacts.rst

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,54 @@
11
Release artifacts
22
#################
33

4-
The |SM| repository contains the following release artifacts:
4+
The |SM| repository contains the release artifacts that you can download from the Assets section of the release on the `release page <github_release_>`_.
5+
The following release artifacts are available:
56

67
.. list-table::
78
:widths: auto
89
:header-rows: 1
910

1011
* - Release artifact
1112
- Description
12-
* - ``serial_modem_{VERSION}_nrf9151dk_normal.hex``
13+
* - ``serial_modem_{VERSION}_nrf9151dk_nrf91m1``
14+
- nRF91M1 content for nRF9151 DK.
15+
* - ``serial_modem_{VERSION}_nrf9151dk_normal``
1316
- Normal build for nRF9151 DK, including PPP and CMUX support to operate with PC.
14-
* - ``serial_modem_{VERSION}_nrf9151dk_normal_mtrace.hex``
17+
* - ``serial_modem_{VERSION}_nrf9151dk_normal_mtrace``
1518
- Normal build with modem traces and application debug logging enabled for nRF9151 DK to operate with PC.
16-
* - ``serial_modem_{VERSION}_nrf9151dk_extmcu.hex``
19+
* - ``serial_modem_{VERSION}_nrf9151dk_extmcu``
1720
- External MCU build for nRF9151 DK, including PPP and CMUX support.
18-
* - ``serial_modem_{VERSION}_nrf9151dk_extmcu_mtrace.hex``
21+
* - ``serial_modem_{VERSION}_nrf9151dk_extmcu_mtrace``
1922
- External MCU build with modem traces and application debug logging enabled for nRF9151 DK.
20-
* - ``sm_at_client_shell_{VERSION}_nrf54l15dk.hex``
21-
- AT client shell build for nRF54L15 DK host that can be used as an external MCU with ``serial_modem_{VERSION}_nrf9151dk_extmcu*.hex``.
23+
* - ``sm_at_client_shell_{VERSION}_nrf54l15dk``
24+
- AT client shell build for nRF54L15 DK host that can be used as an external MCU with ``serial_modem_{VERSION}_nrf9151dk_extmcu``.
2225
See :ref:`uart_configuration` for pin wiring.
23-
* - ``sm_ppp_shell_{VERSION}_nrf54l15dk.hex``
24-
- PPP shell build for nRF54L15 DK host that can be used as an external MCU with ``serial_modem_{VERSION}_nrf9151dk_extmcu*.hex``.
26+
* - ``sm_ppp_shell_{VERSION}_nrf54l15dk``
27+
- PPP shell build for nRF54L15 DK host that can be used as an external MCU with ``serial_modem_{VERSION}_nrf9151dk_extmcu``.
2528
See :ref:`uart_configuration` for pin wiring.
2629

27-
You can download these artifacts from the Assets section of the release on the `release page <github_release_>`_.
30+
The artifacts are zipped and contain build files such as:
31+
32+
.. list-table::
33+
:widths: auto
34+
:header-rows: 1
35+
36+
* - Release artifact
37+
- Description
38+
* - ``.hex``
39+
- The unsigned application binary (MCUboot + application) to be flashed with Programmer or nRF Util.
40+
* - ``.signed.bin``
41+
- Signed application only binary to be used in FOTA/DFU.
42+
* - ``_dfu.zip``
43+
- Signed application only binary zipped with metadata used by nRF Cloud for FOTA/DFU.
44+
* - ``.elf``
45+
- Application image symbols for debugging purposes.
46+
* - ``.dts``
47+
- Devicetree.
48+
* - ``.config``
49+
- Application image Kconfig options.
50+
51+
For more details about the build artifacts, see the `build output files`_ documentation.
2852

2953
.. note::
3054

0 commit comments

Comments
 (0)