lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-07 06:42:56 +03:00
Code Activity

Add migration guide and changelog

Browse Source 
Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
This commit is contained in:
Bence Szépkúti
2021-06-04 00:19:53 +02:00
parent c850054759
commit 90b79ab342
2 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/3.0-migration-guide.d/split_config.md Normal file
View File

@@ -0,0 +1,16 @@
Introduce a level of indirection and versioning in the config files
-------------------------------------------------------------------
`config.h` was split into `build_info.h` and `mbedtls_config.h`.
`build_info.h` is intended to be included from C code directly, while
`mbedtls_config.h` is intended to be edited by end users whishing to
change the build configuration, and should generally only be included from
`build_info.h`. This is because all the preprocessor logic has been moved
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.