mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-02-03 20:54:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Addition of change log and migration guide files.

Browse Source 
Signed-off-by: TRodziewicz <tomasz.rodziewicz@mobica.com>
This commit is contained in:
TRodziewicz 2021-06-09 11:25:28 +02:00
parent 26371e4793
commit 1e66642d68
2 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
ChangeLog.d/issue4212.txt Normal file
View File

@ -0,0 +1,33 @@
Changes
* Rename functions whose deprecated variants have been removed via #4029:
mbedtls_ctr_drbg_update_ret -> mbedtls_ctr_drbg_update
mbedtls_hmac_drbg_update_ret -> mbedtls_hmac_drbg_update
mbedtls_md2_starts_ret -> mbedtls_md2_starts
mbedtls_md2_update_ret -> mbedtls_md2_update
mbedtls_md2_finish_ret -> mbedtls_md2_finish
mbedtls_md2_ret -> mbedtls_md2
mbedtls_md4_starts_ret -> mbedtls_md4_starts
mbedtls_md4_update_ret -> mbedtls_md4_update
mbedtls_md4_finish_ret -> mbedtls_md4_finish
mbedtls_md4_ret -> mbedtls_md4
mbedtls_md5_starts_ret -> mbedtls_md5_starts
mbedtls_md5_update_ret -> mbedtls_md5_update
mbedtls_md5_finish_ret -> mbedtls_md5_finish
mbedtls_md5_ret -> mbedtls_md5
mbedtls_ripemd160_starts_ret -> mbedtls_ripemd160_starts
mbedtls_ripemd160_update_ret -> mbedtls_ripemd160_update
mbedtls_ripemd160_finish_ret -> mbedtls_ripemd160_finish
mbedtls_ripemd160_ret -> mbedtls_ripemd160
mbedtls_sha1_starts_ret -> mbedtls_sha1_starts
mbedtls_sha1_update_ret -> mbedtls_sha1_update
mbedtls_sha1_finish_ret -> mbedtls_sha1_finish
mbedtls_sha1_ret -> mbedtls_sha1
mbedtls_sha256_starts_ret -> mbedtls_sha256_starts
mbedtls_sha256_update_ret -> mbedtls_sha256_update
mbedtls_sha256_finish_ret -> mbedtls_sha256_finish
mbedtls_sha256_ret -> mbedtls_sha256
mbedtls_sha512_starts_ret -> mbedtls_sha512_starts
mbedtls_sha512_update_ret -> mbedtls_sha512_update
mbedtls_sha512_finish_ret -> mbedtls_sha512_finish
mbedtls_sha512_ret -> mbedtls_sha512.
Fixes #4212.

13
docs/3.0-migration-guide.d/rename_the__ret_functions.md Normal file
View File

@ -0,0 +1,13 @@
Rename mbedtls_*_ret() cryptography functions whose deprecated variants have been removed in #4029
--
This change affects users who were using the `mbedtls_*_ret()` criptography functions.
Those functions were created based on now-deprecated functions according to a
requirement that a function needs to return a value. This change brings back the
original names of those functions.
To migrate to the this change the user can keep the `*_ret` names in their code
and include the `compat_2.x.h` header file which holds macros with proper
renaming or to rename those function in their code according to the list from
mentioned header file.