diff options
author | Minos Galanakis <minos.galanakis@arm.com> | 2020-11-16 20:15:48 +0000 |
---|---|---|
committer | Anton Komlev <Anton.Komlev@arm.com> | 2020-11-23 12:02:28 +0000 |
commit | 3568beaf59425bd3a5382f8c17c59654087b8aa7 (patch) | |
tree | c5a6e5ac10d2b98db5853434ba440991eb6d7273 /docs | |
parent | ba3d41c5aac3c7aef9808d457233f48ee1a5a717 (diff) | |
download | trusted-firmware-m-3568beaf59425bd3a5382f8c17c59654087b8aa7.tar.gz |
Build: Semantic versioning support
This patch modifies the project's versioning
schema to support semantic versioning.
The new schema going forward is:
<Major>.<Minor>.Hotfix>
The patch updates:
• The TF-M version macros
* Previous releases' documentation
* The version detection logic for documentation to support
old and new schema
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
Change-Id: I6baa0cab849d656c8d756d4a70c10c258ef3001c
Diffstat (limited to 'docs')
-rw-r--r-- | docs/contributing/release_process.rst | 12 | ||||
-rw-r--r-- | docs/introduction/readme.rst | 4 |
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/contributing/release_process.rst b/docs/contributing/release_process.rst index b47913c879..8b6d1965b1 100644 --- a/docs/contributing/release_process.rst +++ b/docs/contributing/release_process.rst @@ -25,6 +25,18 @@ issues found, additional release candidates may be created to fix the issues. Although this document specifies the release cadence, this does not preclude an adhoc release for specific project requirements. +Release Version Scheme +---------------------- + +Trusted Firmware-M uses a semantic versioning scheme. A version number is +compiled as a dot separated set of numbers: + +**TF-Mv<MAJOR>.<MINOR>.<HOTFIX>** + +- <MAJOR>: Major release version for significant feature and API changes. +- <MINOR>: Minor release version for incremental features and API changes. +- <HOTFIX>: Used only for backporting **critical bug fix/security patches**. + -------------- *Copyright (c) 2020, Arm Limited. All rights reserved.* diff --git a/docs/introduction/readme.rst b/docs/introduction/readme.rst index b5ddecc3bc..b53c12c2e6 100644 --- a/docs/introduction/readme.rst +++ b/docs/introduction/readme.rst @@ -188,6 +188,10 @@ Version history | v1.1 | 2020-07-15 | 1.1 release | 1f960947 | +-------------+--------------+--------------------+-------------------+ +Please refer to +:ref:`docs/contributing/release_process:Release Version Scheme` for interpreting +version numbers. + .. _Cortex-M33: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m33 .. _Cortex-M23: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m23 .. _Cortex-M55: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m55 |