Skip to content

Commit 323787a

Browse files
Apply suggestions from code review
Co-authored-by: Divya S Pillai <91891495+divipillai@users.noreply.github.com>
1 parent 832b8c4 commit 323787a

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

doc/app/sm_releasing.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Releasing |SM|
44
##############
55

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.
77
Each published application image must carry a higher MCUboot sign version than the previous one on the same product line.
88
Increment ``CONFIG_FW_INFO_FIRMWARE_VERSION`` only when the MCUboot bootloader image changes.
99

10-
Application :file:`app/VERSION`
10+
Application - :file:`app/VERSION`
1111
=================================
1212

1313
:file:`app/VERSION` is the single source of truth for:
@@ -21,14 +21,15 @@ DFU and ``AT#XSMVER``
2121
---------------------
2222

2323
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`.
2526
The Git suffix is informational only and is not used for downgrade checks.
2627

2728
Pre-release numbering
2829
---------------------
2930

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

3334
v2.0.0 GA
3435
~~~~~~~~~
@@ -65,7 +66,7 @@ At GA, set the product version to ``2.0.0``.
6566
Future v2.1.0 GA
6667
~~~~~~~~~~~~~~~~
6768

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-releasethe 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.
6970
At v2.1.0 GA, set ``VERSION_MAJOR``, ``VERSION_MINOR``, and ``PATCHLEVEL`` to ``2``, ``1``, and ``0``.
7071

7172
General Availability and later
@@ -81,11 +82,9 @@ Confirm the version with :ref:`SM_AT_XSMVER`.
8182
MCUboot — ``CONFIG_FW_INFO_FIRMWARE_VERSION``
8283
=============================================
8384

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

8988
After an MCUboot update, ``AT#XBOOTINFO=0`` reports the active slot value.
9089

91-
See :ref:`serial_modem_release_notes`.
90+
See :ref:`serial_modem_release_notes` for more information.

doc/releases/migration_notes_v2.0.0.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Informational changes
2828

2929
The following changes are listed for informational purposes, and many hosts will work without any changes.
3030

31-
* Application rollback prevention Application firmware DFU now uses MCUboot downgrade prevention (``CONFIG_MCUBOOT_DOWNGRADE_PREVENTION``).
31+
* Application rollback prevention - Application firmware DFU now uses MCUboot downgrade prevention (``CONFIG_MCUBOOT_DOWNGRADE_PREVENTION``).
3232
The device rejects signed application images older than the version currently running.
3333
Set :file:`app/VERSION` before each published build; see :ref:`sm_releasing`.
3434

35-
* ``AT#XSMVER`` No change to the response layout for hosts.
35+
* ``AT#XSMVER`` - No change to the response layout for hosts.
3636
``<sm_version>`` is still a quoted Git-describe-style string (for example ``"v2.0.0-18-g2c85d9224fca"``).
3737
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.
3939

4040
* Ring Indication (RI) - Change RI from pulse (100 ms) to level triggered, meaning RI stays asserted until the host asserts DTR.
4141
After the Serial Modem has enabled UART, RI will be deasserted.

0 commit comments

Comments
 (0)