Corrections to the docs wording and changes to aux scripts
Signed-off-by: TRodziewicz <tomasz.rodziewicz@mobica.com>
diff --git a/ChangeLog.d/issue4212.txt b/ChangeLog.d/issue4212.txt
index 4943d71..9e72ca9 100644
--- a/ChangeLog.d/issue4212.txt
+++ b/ChangeLog.d/issue4212.txt
@@ -1,33 +1,6 @@
API 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.
+ * In modules that implement cryptographic hash functions, many functions
+ mbedtls_xxx() now return int instead of void, and the corresponding
+ function mbedtls_xxx_ret() which was identical except for returning int
+ has been removed. This also concerns mbedtls_xxx_drbg_update(). See the
+ migration guide for more information. Fixes #4212.
diff --git a/docs/3.0-migration-guide.d/rename_the__ret_functions.md b/docs/3.0-migration-guide.d/rename_the__ret_functions.md
index c6fe714..44435f8 100644
--- a/docs/3.0-migration-guide.d/rename_the__ret_functions.md
+++ b/docs/3.0-migration-guide.d/rename_the__ret_functions.md
@@ -1,15 +1,51 @@
Rename mbedtls_*_ret() cryptography functions whose deprecated variants
-have been removed in #4029
---------------------------
+have been removed
+-----------------
This change affects users who were using the `mbedtls_*_ret()` cryptography
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.
+original names of those functions. The renamed functions are:
+
+| name before this change | after the change |
+|------------------------------|--------------------------|
+| 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 |
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.
+
+
+
diff --git a/tests/scripts/list-enum-consts.pl b/tests/scripts/list-enum-consts.pl
index 225612f..6d93693 100755
--- a/tests/scripts/list-enum-consts.pl
+++ b/tests/scripts/list-enum-consts.pl
@@ -23,8 +23,7 @@
-d 'include/mbedtls' or die "$0: must be run from root\n";
-@ARGV = <include/mbedtls/*.h>;
-push @ARGV, <library/*.h>;
+@ARGV = grep { ! /compat-2\.x\.h/ } <include/mbedtls/*.h>;
push @ARGV, "3rdparty/everest/include/everest/everest.h";
push @ARGV, "3rdparty/everest/include/everest/x25519.h";
push @ARGV, glob("library/*.h");
diff --git a/tests/scripts/list-identifiers.sh b/tests/scripts/list-identifiers.sh
index b8a6d53..9698fc8 100755
--- a/tests/scripts/list-identifiers.sh
+++ b/tests/scripts/list-identifiers.sh
@@ -47,9 +47,9 @@
if [ $INTERNAL ]
then
- HEADERS=$( ls library/*.h )
+ HEADERS=$( ls include/mbedtls/*_internal.h library/*.h | egrep -v 'compat-2\.x\.h' )
else
- HEADERS=$( ls include/mbedtls/*.h include/psa/*.h library/*.h )
+ HEADERS=$( ls include/mbedtls/*.h include/psa/*.h library/*.h | egrep -v 'compat-2\.x\.h' )
HEADERS="$HEADERS 3rdparty/everest/include/everest/everest.h 3rdparty/everest/include/everest/x25519.h"
fi