From 2ff02c361e65a3fac94f9a5dce1db3f97cf6606f Mon Sep 17 00:00:00 2001
From: Gilles Peskine <Gilles.Peskine@arm.com>
Date: Fri, 29 Nov 2019 12:17:21 +0100
Subject: [PATCH] Document MBEDTLS_TEST_DEPRECATED

---
 tests/suites/main_test.function | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/tests/suites/main_test.function b/tests/suites/main_test.function
index 6ddfc5927a..a1ba610585 100644
--- a/tests/suites/main_test.function
+++ b/tests/suites/main_test.function
@@ -29,6 +29,11 @@
 #include "psa/crypto.h"
 #endif /* MBEDTLS_USE_PSA_CRYPTO */
 
+/* Test code may use deprecated identifiers only if the preprocessor symbol
+ * MBEDTLS_TEST_DEPRECATED is defined. When building tests, set
+ * MBEDTLS_TEST_DEPRECATED explicitly if MBEDTLS_DEPRECATED_WARNING is
+ * enabled but the corresponding warnings are not treated as errors.
+ */
 #if !defined(MBEDTLS_DEPRECATED_REMOVED) && !defined(MBEDTLS_DEPRECATED_WARNING)
 #define MBEDTLS_TEST_DEPRECATED
 #endif