mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-29 04:20:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
mbedtls/docs/3.0-migration-guide.d/split_config.md
Bence Szépkúti 9cd7065307 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 14:29:42 +01:00

1.1 KiB
Raw Blame History

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.