From 3c358d4e12bd48f1fae13d891b8d5f2f168ec7a2 Mon Sep 17 00:00:00 2001 From: Hanno Becker Date: Wed, 20 May 2020 13:54:41 +0100 Subject: [PATCH] Improve documentation of MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL Signed-off-by: Hanno Becker --- include/mbedtls/config.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/include/mbedtls/config.h b/include/mbedtls/config.h index 5474bbd5f..e1de6f82e 100644 --- a/include/mbedtls/config.h +++ b/include/mbedtls/config.h @@ -1709,13 +1709,16 @@ /** * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL * - * This is an experimental macro used to selectively enable parts - * of the code that solely contribute to the ongoing development of - * a prototype implementation for TLS 1.3 and DTLS 1.3 but aren't - * used otherwise. + * This macro is used to selectively enable experimental parts + * of the code that contribute to the ongoing development of + * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide + * no other purpose. * - * \warning Features under the control of this macro are experimental - * and don't come with any stability guarantees. + * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS, + * and no feature exposed through this macro is part of the + * public API. In particular, features under the control + * of this macro are experimental and don't come with any + * stability guarantees. * * Uncomment this macro to enable experimental and partial * functionality specific to TLS 1.3.