Skip to content

Commit 76a27e8

Browse files
Damian-Nordicrlubos
authored andcommitted
matter: include EXTRAVERSION in Matter software version string
Switch the Matter software version string from APP_VERSION_TWEAK_STRING to APP_VERSION_EXTENDED_STRING. Signed-off-by: Damian Krolik <[email protected]>
1 parent 012b7ba commit 76a27e8

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

doc/nrf/protocols/matter/end_product/versioning.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ There are two primary approaches for maintaining versioning:
1616
* Utilizing a :file:`VERSION` file as detailed on the :ref:`app-version-details` page of the Zephyr Project documentation.
1717
This method involves defining the version information in a specific file format.
1818

19-
* Implementing dedicated Kconfig configurations.
20-
This approach uses Kconfig system configurations to set and manage the versioning details.
19+
* Utilizing dedicated Kconfig configurations.
20+
This approach uses Kconfig options to set and manage the versioning details.
2121

2222
Choose the approach that best aligns with your project requirements and infrastructure.
2323

2424
.. note::
25-
These approaches should not be used simultaneously.
25+
These approaches cannot be used simultaneously.
26+
The Kconfig options for configuring the versioning details are unavailable if the :file:`VERSION` file is present.
2627

2728
Using :file:`VERSION` file
2829
**************************
@@ -35,6 +36,7 @@ To implement versioning based on a :file:`VERSION` file, you must create a file
3536
VERSION_MINOR =
3637
PATCHLEVEL =
3738
VERSION_TWEAK =
39+
EXTRAVERSION =
3840
3941
.. note::
4042
You must assign a value to at least one of the variables.
@@ -48,13 +50,20 @@ For example:
4850
VERSION_MINOR = 5
4951
PATCHLEVEL = 99
5052
VERSION_TWEAK = 0
53+
EXTRAVERSION = dev
5154
52-
A :file:`VERSION` file is responsible for assigning values in the following format for:
55+
The :file:`VERSION` file is used to derive the firmware version in the following format for:
5356

54-
* MCUboot version: ``MAJOR . MINOR . PATCHLEVEL + TWEAK``.
55-
The above example would be formatted as ``2 . 5 . 99 + 0``.
56-
* Matter OTA: in the 32-bit integer where each variable is 8 bits long.
57+
* MCUboot image: ``MAJOR.MINOR.PATCHLEVEL+TWEAK``.
58+
The above example would be formatted as ``2.5.99+0``.
59+
* Matter OTA image: 32-bit integer where each numeric variable is represented by 8 bits within the integer.
5760
The above example would be formatted as ``0x02056300``.
61+
* Informational purposes, for example displayed in the ecosystem applications:
62+
63+
* If ``EXTRAVERSION`` is non-empty: ``MAJOR.MINOR.PATCHLEVEL-EXTRA+TWEAK``.
64+
The above example would be formatted as ``2.5.99-dev+0``.
65+
* Otherwise: ``MAJOR.MINOR.PATCHLEVEL+TWEAK``.
66+
The above example would be formatted as ``2.5.99+0``.
5867

5968
Using Kconfig options
6069
*********************

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,8 @@ Matter
224224
* The default Trusted Storage AEAD key to Hardware Unique Key (HUK) for supported nRF54L Series devices.
225225
* Renamed the ``CONFIG_CHIP_FACTORY_RESET_ERASE_NVS`` Kconfig option to :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS`.
226226
The new Kconfig option now works for both NVS and ZMS file system backends.
227+
* The firmware version format used for informational purposes when using the :file:``VERSION`` file.
228+
The format now includes the optional ``EXTRAVERSION`` component.
227229

228230
Matter fork
229231
+++++++++++

west.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ manifest:
161161
- name: matter
162162
repo-path: sdk-connectedhomeip
163163
path: modules/lib/matter
164-
revision: 171a1d323bf91ac7a655f93c70c18ebb6c1a2253
164+
revision: 731aac5c8941bf0f0a9f10c759f533e5b01f80eb
165165
west-commands: scripts/west/west-commands.yml
166166
submodules:
167167
- name: nlio

0 commit comments

Comments
 (0)