blob: fc809258d668b3f84dbf3a0cc10557f6a56e99a1 [file] [log] [blame] [view]
Bence Szépkúti90b79ab2021-06-04 00:19:53 +02001Introduce a level of indirection and versioning in the config files
2-------------------------------------------------------------------
3
4`config.h` was split into `build_info.h` and `mbedtls_config.h`.
5`build_info.h` is intended to be included from C code directly, while
Bence Szépkúti8d9132f2021-06-16 09:10:41 +02006`mbedtls_config.h` is intended to be edited by end users wishing to
Bence Szépkúti90b79ab2021-06-04 00:19:53 +02007change the build configuration, and should generally only be included from
8`build_info.h`. This is because all the preprocessor logic has been moved
9into `build_info.h`, including the handling of the `MBEDTLS_CONFIG_FILE`
10macro.
11
Bence Szépkúti36da4cc2021-06-21 17:14:41 +020012Config file symbols `MBEDTLS_CONFIG_VERSION` and `MBEDTLS_USER_CONFIG_VERSION`
13were introduced for use in `MBEDTLS_CONFIG_FILE` and
14`MBEDTLS_USER_CONFIG_FILE` respectively.
15Defining them to a particular value will ensure that mbedtls interprets
16the config file in a way that's compatible with the config file format
17indicated by the value.
18The config file versions are based on the value of `MBEDTLS_VERSION_NUMBER`
19of the mbedtls version that first introduced that config file format.
20The only value currently supported is `0x03000000`.