You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/app/sm_releasing.rst
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,11 @@
3
3
Releasing |SM|
4
4
##############
5
5
6
-
Before each official release or pre-release, update the version metadata below.
6
+
Before each official release or pre-release, update the following version metadata.
7
7
Each published application image must carry a higher MCUboot sign version than the previous one on the same product line.
8
8
Increment ``CONFIG_FW_INFO_FIRMWARE_VERSION`` only when the MCUboot bootloader image changes.
9
9
10
-
Application —:file:`app/VERSION`
10
+
Application -:file:`app/VERSION`
11
11
=================================
12
12
13
13
:file:`app/VERSION` is the single source of truth for:
@@ -21,14 +21,15 @@ DFU and ``AT#XSMVER``
21
21
---------------------
22
22
23
23
For application firmware update, a host can read ``AT#XSMVER`` before and after DFU and compare the ``major.minor.patchlevel`` prefix of ``<sm_version>`` (the part from :file:`app/VERSION`, before any ``-N-g<hash>`` Git suffix).
24
-
That value must increase when moving to a newer published image; MCUboot enforces the same ordering via the sign version derived from :file:`app/VERSION`.
24
+
That value must increase when moving to a newer published image.
25
+
MCUboot enforces the same ordering using the sign version derived from :file:`app/VERSION`.
25
26
The Git suffix is informational only and is not used for downgrade checks.
26
27
27
28
Pre-release numbering
28
29
---------------------
29
30
30
31
Before General Availability (GA) for a target ``X.Y.Z``, use a staging line below ``X.Y.Z`` and increment ``PATCHLEVEL`` for each published pre-release.
31
-
Keep ``VERSION_TWEAK = 0`` unless you have a separate reason to use it after GA.
32
+
Keep ``VERSION_TWEAK = 0`` unless you have a specific reason to use it after GA.
32
33
33
34
v2.0.0 GA
34
35
~~~~~~~~~
@@ -65,7 +66,7 @@ At GA, set the product version to ``2.0.0``.
65
66
Future v2.1.0 GA
66
67
~~~~~~~~~~~~~~~~
67
68
68
-
Pre-releases before v2.1.0 GA use the ``2.0.99`` line (for example ``2.0.99``, then ``2.0.100``), incrementing ``PATCHLEVEL`` for each published pre-release—the same pattern as ``1.99.0``, ``1.99.1`` before v2.0.0 GA.
69
+
Pre-releases before v2.1.0 GA, use the ``2.0.99`` line (for example ``2.0.99``, then ``2.0.100``), incrementing ``PATCHLEVEL`` for each published pre-release, following the same pattern as ``1.99.0``, ``1.99.1`` before v2.0.0 GA.
69
70
At v2.1.0 GA, set ``VERSION_MAJOR``, ``VERSION_MINOR``, and ``PATCHLEVEL`` to ``2``, ``1``, and ``0``.
70
71
71
72
General Availability and later
@@ -81,11 +82,9 @@ Confirm the version with :ref:`SM_AT_XSMVER`.
81
82
MCUboot — ``CONFIG_FW_INFO_FIRMWARE_VERSION``
82
83
=============================================
83
84
84
-
:file:`app/sysbuild/mcuboot/prj.conf`
85
-
86
-
Increment only when the MCUboot bootloader image changes.
87
-
Used by NSIB (B0) for MCUboot slot downgrade prevention — independent of :file:`app/VERSION`.
85
+
In :file:`app/sysbuild/mcuboot/prj.conf`, increment the value only when the MCUboot bootloader image changes.
86
+
The value is used by NSIB (B0) for MCUboot slot downgrade prevention and is independent of :file:`app/VERSION`.
88
87
89
88
After an MCUboot update, ``AT#XBOOTINFO=0`` reports the active slot value.
90
89
91
-
See :ref:`serial_modem_release_notes`.
90
+
See :ref:`serial_modem_release_notes` for more information.
The device rejects signed application images older than the version currently running.
33
33
Set :file:`app/VERSION` before each published build; see :ref:`sm_releasing`.
34
34
35
-
* ``AT#XSMVER`` — No change to the response layout for hosts.
35
+
* ``AT#XSMVER`` - No change to the response layout for hosts.
36
36
``<sm_version>`` is still a quoted Git-describe-style string (for example ``"v2.0.0-18-g2c85d9224fca"``).
37
37
Existing parsers can keep using it as in v1.x.x.
38
-
The ``major.minor.patch`` part now follows :file:`app/VERSION` (same value used for rollback prevention); the ``-N-g<hash>`` suffix still comes from Git.
38
+
The ``major.minor.patch`` part now follows :file:`app/VERSION` (same value used for rollback prevention), the ``-N-g<hash>`` suffix still comes from Git.
39
39
40
40
* Ring Indication (RI) - Change RI from pulse (100 ms) to level triggered, meaning RI stays asserted until the host asserts DTR.
41
41
After the Serial Modem has enabled UART, RI will be deasserted.
0 commit comments