From a3d55d9ec71a7366e581447d2b0495d8795a22df Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Mon, 2 Mar 2026 13:21:01 +0100 Subject: [PATCH] Document the purpose of mbedtls_common.h Signed-off-by: Gilles Peskine --- library/mbedtls_common.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/library/mbedtls_common.h b/library/mbedtls_common.h index 2aacfcbc22..ef8448e12b 100644 --- a/library/mbedtls_common.h +++ b/library/mbedtls_common.h @@ -1,7 +1,19 @@ /** * \file mbedtls_common.h * - * \brief Utility macros for internal use in the library + * \brief Utility macros for internal use in the library. + * + * This file should be included as the first thing in all library C files + * (directly, or indirectly via x509_internal.h or ssl_misc.h). + * It must not be included by sample programs, since sample programs + * illustrate what you can do without the library sources. + * It may be included (often indirectly) by test code that isn't purely + * black-box testing. + * + * This file takes care of setting up requirements for platform headers. + * It includes the library configuration and derived macros. + * It additionally defines various utility macros and other definitions + * (but no function declarations). */ /* * Copyright The Mbed TLS Contributors