commit 23fd2bdb94c8f182ba14471d857d248236129bbd
author Gilles Peskine <Gilles.Peskine@arm.com> Tue Dec 11 15:51:32 2018 +0100
committer Gilles Peskine <Gilles.Peskine@arm.com> Tue Dec 11 16:48:14 2018 +0100
tree e93ccbd294528e5852e83ab12b018a7e2f287793
parent 79a11d6c422be6662cb17a9bdd1255807f33549f

Update some documentation related to key slots

Some of the documentation is obsolete in its reference to key slots
when it should discuss key handles. This may require a further pass,
possibly with some reorganization of error codes.

Update the documentation of functions that modify key slots (key
material creation and psa_set_key_policy()) to discuss how they affect
storage.

library/psa_crypto_slot_management.c

diff --git a/library/psa_crypto_slot_management.c b/library/psa_crypto_slot_management.c
index f623cc9..4e193b5 100644
--- a/library/psa_crypto_slot_management.c
+++ b/library/psa_crypto_slot_management.c
@@ -100,7 +100,8 @@
 
 /** Find a free key slot and mark it as in use.
  *
- * \param[out] handle   On success, a slot number that is not in use.
+ * \param[out] handle   On success, a slot number that is not in use. This
+ *                      value can be used as a handle to the slot.
  *
  * \retval #PSA_SUCCESS
  * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
@@ -123,7 +124,7 @@
  *
  * This does not affect persistent storage.
  *
- * \param handle        The key slot number to release.
+ * \param handle        The handle to the key slot to release.
  *
  * \retval #PSA_SUCCESS
  * \retval #PSA_ERROR_INVALID_ARGUMENT