mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-01-26 03:35:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update changelog and migration guide

Browse Source 
This reflect changes to the config version symbols.

Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
This commit is contained in:
Bence Szépkúti 2021-06-21 17:14:41 +02:00
parent 2bb7456334
commit 36da4ccc51
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
ChangeLog.d/split-config.txt
View File

@ -5,8 +5,12 @@ Changes
change the build configuration, and should generally only be included from
build_info.h.
* The handling of MBEDTLS_CONFIG_FILE has been moved into build_info.h.
* Mandatory version symbols MBEDTLS_CONFIG_VERSION and
MBEDTLS_USER_CONFIG_VERSION were introduced for MBEDTLS_CONFIG_FILE and
MBEDTLS_USER_CONFIG_FILE respectively. They have to be defined with a
value of one in their respective config file for the config to be
considered valid.
* Config file symbols MBEDTLS_CONFIG_VERSION and MBEDTLS_USER_CONFIG_VERSION
were introduced for use in MBEDTLS_CONFIG_FILE and
MBEDTLS_USER_CONFIG_FILE respectively.
Defining them to a particular value will ensure that mbedtls interprets
the config file in a way that's compatible with the config file format
indicated by the value.
The config file versions are based on the value of MBEDTLS_VERSION_NUMBER
of the mbedtls version that first introduced that config file format.
The only value currently supported is 0x03000000.

14
docs/3.0-migration-guide.d/split_config.md
View File

@ -9,8 +9,12 @@ change the build configuration, and should generally only be included from
into `build_info.h`, including the handling of the `MBEDTLS_CONFIG_FILE`
macro.
Mandatory version symbols were introduced for `MBEDTLS_CONFIG_FILE` and
`MBEDTLS_USER_CONFIG_FILE`, `MBEDTLS_CONFIG_VERSION` and
`MBEDTLS_USER_CONFIG_VERSION` respectively. Both config files should include
a definiton of their respective version symbol, with a value of `1` to be
considered valid.
Config file symbols `MBEDTLS_CONFIG_VERSION` and `MBEDTLS_USER_CONFIG_VERSION`
were introduced for use in `MBEDTLS_CONFIG_FILE` and
`MBEDTLS_USER_CONFIG_FILE` respectively.
Defining them to a particular value will ensure that mbedtls interprets
the config file in a way that's compatible with the config file format
indicated by the value.
The config file versions are based on the value of `MBEDTLS_VERSION_NUMBER`
of the mbedtls version that first introduced that config file format.
The only value currently supported is `0x03000000`.