commit f0f7c19457eb9bc05661b41cf246a66bcb13c5dd
author Ron Eldor <Ron.Eldor@arm.com> Thu Dec 06 17:21:52 2018 +0200
committer Johan Pascal <johan.pascal@belledonne-communications.com> Thu Oct 29 01:14:49 2020 +0100
tree 2b57c8e79d5db3629c5ee6708ad4a10fe3f31c54
parent 089c9fe9fa0eb7419b0c40b9b52b4349f8cb26c5

Add comment describing the feature

Add a comment that describes that the feature only supportes the
`use_srtp` extension, and not hte full DTLS-SRTP RFC.

Signed-off-by: Johan Pascal <johan.pascal@belledonne-communications.com>

include/mbedtls/config.h

diff --git a/include/mbedtls/config.h b/include/mbedtls/config.h
index 2ed3ec2..cd7c073 100644
--- a/include/mbedtls/config.h
+++ b/include/mbedtls/config.h
@@ -1815,7 +1815,10 @@
 /**
  * \def MBEDTLS_SSL_DTLS_SRTP
  *
- * Enable support for DTLS-SRTP, RFC5764
+ * Enable support for DTLS-SRTP, RFC5764, use_srtp extension.
+ * \note Only the dtls-srtp key material negotiation is supported.
+ * Once negotiated, the key should be extracted, and data should be transmitted
+ * via an SRTP stack.
  *
  * Requires: MBEDTLS_SSL_PROTO_DTLS
  *