From 04e4c19ee3337b8cedc6712a2f042bf598229446 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Thu, 15 Sep 2022 20:19:01 +0200 Subject: [PATCH] Document the base state of platform abstraction It's `#define mbedtls_xxx xxx` unless some option to override `mbedtls_xxx` is enabled. Signed-off-by: Gilles Peskine --- include/mbedtls/platform.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/mbedtls/platform.h b/include/mbedtls/platform.h index a5a43ac6d2..62e12d267c 100644 --- a/include/mbedtls/platform.h +++ b/include/mbedtls/platform.h @@ -11,6 +11,13 @@ * implementations of these functions, or implementations specific to * their platform, which can be statically linked to the library or * dynamically configured at runtime. + * + * When all compilation options related to platform abstraction are + * disabled, this header just defines `mbedtls_xxx` function names + * as aliases to the standard `xxx` function. + * + * Most modules in the library and example programs are expected to + * include this header. */ /* * Copyright The Mbed TLS Contributors