From 0d24575ad060316b971e10cb062cc82156b1df0f Mon Sep 17 00:00:00 2001 From: Neil Armstrong Date: Fri, 20 May 2022 11:35:40 +0200 Subject: [PATCH] Clarify BAD_STATE return documentation of psa_pake_set_peer() Signed-off-by: Neil Armstrong --- include/psa/crypto_extra.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/psa/crypto_extra.h b/include/psa/crypto_extra.h index 2f1fefb385..26d9d9c061 100644 --- a/include/psa/crypto_extra.h +++ b/include/psa/crypto_extra.h @@ -1528,7 +1528,8 @@ psa_status_t psa_pake_set_user(psa_pake_operation_t *operation, * \retval #PSA_ERROR_COMMUNICATION_FAILURE * \retval #PSA_ERROR_CORRUPTION_DETECTED * \retval #PSA_ERROR_BAD_STATE - * The operation state is not valid, or the library has not + * Calling psa_pake_set_peer() is invalid with the \p operation's + * algorithm, the operation state is not valid, or the library has not * been previously initialized by psa_crypto_init(). * It is implementation-dependent whether a failure to initialize * results in this error code.