mbedtls/docs/3.0-migration-guide.d/split_config.md

Introduce a level of indirection and versioning in the config files
-------------------------------------------------------------------

`config.h` was split into `build_info.h` and `mbedtls_config.h`.

* In code, use `#include <mbedtls/build_info.h>`. Don't include `mbedtls/config.h` and don't refer to `MBEDTLS_CONFIG_FILE`.
* In build tools, edit `mbedtls_config.h`, or edit `MBEDTLS_CONFIG_FILE` as before.
* If you had a tool that parsed the library version from `include/mbedtls/version.h`, this has moved to `include/mbedtls/build_info.h`. From C code, both headers now define the `MBEDTLS_VERSION_xxx` macros.

Also, if you have a custom configuration file:

* Don't include `check_config.h` or `config_psa.h` anymore.
* Don't define `MBEDTLS_CONFIG_H` anymore.

A config file version symbol, `MBEDTLS_CONFIG_VERSION` was introduced.
Defining it to a particular value will ensure that Mbed TLS interprets
the config file in a way that's compatible with the config file format
used by the Mbed TLS release whose `MBEDTLS_VERSION_NUMBER` has the same
value.
The only value supported by Mbed TLS 3.0.0 is `0x03000000`.
Add migration guide and changelog Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-04 00:19:53 +02:00			`Introduce a level of indirection and versioning in the config files`
			`-------------------------------------------------------------------`

			`config.h` was split into `build_info.h` and `mbedtls_config.h`.
Improve the instructions in the migration guide Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-28 11:34:29 +02:00
			* In code, use `#include <mbedtls/build_info.h>`. Don't include `mbedtls/config.h` and don't refer to `MBEDTLS_CONFIG_FILE`.
			* In build tools, edit `mbedtls_config.h`, or edit `MBEDTLS_CONFIG_FILE` as before.
			* If you had a tool that parsed the library version from `include/mbedtls/version.h`, this has moved to `include/mbedtls/build_info.h`. From C code, both headers now define the `MBEDTLS_VERSION_xxx` macros.

			`Also, if you have a custom configuration file:`

No other headers are included by mbedtls_config.h These have been moved to build_info.h. Update the documentation to reflect this. Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-28 15:22:39 +02:00			* Don't include `check_config.h` or `config_psa.h` anymore.
Improve the instructions in the migration guide Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-28 11:34:29 +02:00			* Don't define `MBEDTLS_CONFIG_H` anymore.
Add migration guide and changelog Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-04 00:19:53 +02:00
Remove references to MBEDTLS_USER_CONFIG_VERSION Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-22 10:03:02 +02:00			A config file version symbol, `MBEDTLS_CONFIG_VERSION` was introduced.
Correct documentation references to Mbed TLS Use the correct formatting of the product name in the documentation. Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-28 11:26:11 +02:00			`Defining it to a particular value will ensure that Mbed TLS interprets`
Update changelog and migration guide This reflect changes to the config version symbols. Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-21 17:14:41 +02:00			`the config file in a way that's compatible with the config file format`
Correct documentation references to Mbed TLS Use the correct formatting of the product name in the documentation. Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-28 11:26:11 +02:00			used by the Mbed TLS release whose `MBEDTLS_VERSION_NUMBER` has the same
Remove references to MBEDTLS_USER_CONFIG_VERSION Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-22 10:03:02 +02:00			`value.`
Correct documentation references to Mbed TLS Use the correct formatting of the product name in the documentation. Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-06-28 11:26:11 +02:00			The only value supported by Mbed TLS 3.0.0 is `0x03000000`.