From 916ed7b8dbbf1aa5fe5542cd24d74a48d617b3a9 Mon Sep 17 00:00:00 2001 From: Waleed Elmelegy Date: Mon, 25 Sep 2023 15:18:48 +0100 Subject: [PATCH] restore internal comment in cipher.h due to LTS Signed-off-by: Waleed Elmelegy --- include/mbedtls/cipher.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/mbedtls/cipher.h b/include/mbedtls/cipher.h index 784b4e301..fa57efeb0 100644 --- a/include/mbedtls/cipher.h +++ b/include/mbedtls/cipher.h @@ -476,6 +476,10 @@ void mbedtls_cipher_free(mbedtls_cipher_context_t *ctx); * parameter-verification failure. * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the * cipher-specific context fails. + * + * \internal Currently, the function also clears the structure. + * In future versions, the caller will be required to call + * mbedtls_cipher_init() on the structure first. */ int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info);