From 36da4ccc5144279325530ef01d38e4b55673628a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bence=20Sz=C3=A9pk=C3=BAti?= Date: Mon, 21 Jun 2021 17:14:41 +0200 Subject: [PATCH] Update changelog and migration guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This reflect changes to the config version symbols. Signed-off-by: Bence Szépkúti --- ChangeLog.d/split-config.txt | 14 +++++++++----- docs/3.0-migration-guide.d/split_config.md | 14 +++++++++----- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/ChangeLog.d/split-config.txt b/ChangeLog.d/split-config.txt index 7fe2955f1a..9a1c678305 100644 --- a/ChangeLog.d/split-config.txt +++ b/ChangeLog.d/split-config.txt @@ -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. diff --git a/docs/3.0-migration-guide.d/split_config.md b/docs/3.0-migration-guide.d/split_config.md index 8fba5b3551..fc809258d6 100644 --- a/docs/3.0-migration-guide.d/split_config.md +++ b/docs/3.0-migration-guide.d/split_config.md @@ -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`.