commit 2056d098938d70d6bdf4cefe38e4950a07f41e25
author Minos Galanakis <minos.galanakis@arm.com> Tue May 02 14:53:58 2023 +0100
committer Minos Galanakis <minos.galanakis@arm.com> Tue May 16 17:16:26 2023 +0100
tree 7e790e2ab6dd09cf9369765306d9c19411c67805
parent 0144b35f7d8b637a7bf29c8d7883622bdab75620

bignum: Updated documentation for `mbedtls_mpi_shift_l()`

Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>

include/mbedtls/bignum.h

diff --git a/include/mbedtls/bignum.h b/include/mbedtls/bignum.h
index 5c2c843..e7f3131 100644
--- a/include/mbedtls/bignum.h
+++ b/include/mbedtls/bignum.h
@@ -594,6 +594,8 @@
  * \brief          Perform a left-shift on an MPI: X <<= count
  *
  * \param X        The MPI to shift. This must point to an initialized MPI.
+ *                 The MPI pointed by \p X may be resized to fit
+ *                 the resulting number.
  * \param count    The number of bits to shift by.
  *
  * \return         \c 0 if successful.