aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRonald Cron <ronald.cron@arm.com>2024-05-17 13:18:52 +0200
committerRonald Cron <ronald.cron@arm.com>2024-05-17 14:34:11 +0200
commitb48c8704e61e04ba8dc93cc1cb22f9a6e71119ad (patch)
tree239a9e5ca0f856daadebd078c86917bc9a002a36 /include
parentc4c8bdf32e60a3592b17d6da013e9d779bbc3bff (diff)
downloadmbedtls-b48c8704e61e04ba8dc93cc1cb22f9a6e71119ad.zip
mbedtls-b48c8704e61e04ba8dc93cc1cb22f9a6e71119ad.tar.gz
mbedtls-b48c8704e61e04ba8dc93cc1cb22f9a6e71119ad.tar.bz2
Fix crypto_adjust_config_dependencies.h documentation
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
Diffstat (limited to 'include')
-rw-r--r--include/psa/crypto_adjust_config_dependencies.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/psa/crypto_adjust_config_dependencies.h b/include/psa/crypto_adjust_config_dependencies.h
index aeedf68..5a22205 100644
--- a/include/psa/crypto_adjust_config_dependencies.h
+++ b/include/psa/crypto_adjust_config_dependencies.h
@@ -2,9 +2,13 @@
* \file psa/crypto_adjust_config_dependencies.h
* \brief Adjust PSA configuration by resolving some dependencies.
*
+ * This is an internal header. Do not include it directly.
+ *
* See docs/proposed/psa-conditional-inclusion-c.md.
- * If a cryptographic mechanism A depends on a cryptographic mechanism B and
- * A is enabled then enable B.
+ * If the Mbed TLS implementation of a cryptographic mechanism A depends on a
+ * cryptographic mechanism B then if the cryptographic mechanism A is enabled
+ * and not accelerated enable B. Note that if A is enabled and accelerated, it
+ * is not necessary to enable B for A support.
*/
/*
* Copyright The Mbed TLS Contributors