TeamHepta/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2026-03-20 19:21:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document the purpose of mbedtls_common.h

Browse Source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2026-03-02 13:21:01 +01:00
parent eb1328285b
commit a3d55d9ec7
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
library/mbedtls_common.h
View File

@@ -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