1
0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-29 11:41:15 +03:00

Place MBEDTLS_CONFIG_FILE and such into a new section

Include this new section in the "full for documentation" (`realfull`)
configuration, so that these options are documented in the official
documentation build (`scripts/apidoc_full.sh`).

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2022-04-11 17:04:38 +02:00
parent 7d904e7127
commit ba4162a526
2 changed files with 28 additions and 4 deletions

View File

@ -3084,7 +3084,7 @@
/** \} name SECTION: mbed TLS modules */
/**
* \name SECTION: Module configuration options
* \name SECTION: General configuration options
*
* This section allows for the setting of module specific sizes and
* configuration options. The default values are already present in the
@ -3098,7 +3098,6 @@
* \{
*/
/* Meta configuration */
/**
* \def MBEDTLS_CONFIG_FILE
*
@ -3163,6 +3162,23 @@
*/
//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
/** \} name SECTION: General configuration options */
/**
* \name SECTION: Module configuration options
*
* This section allows for the setting of module specific sizes and
* configuration options. The default values are already present in the
* relevant header files and should suffice for the regular use cases.
*
* Our advice is to enable options and change their values here
* only if you have a good reason and know the consequences.
*
* Please check the respective header file for documentation on these
* parameters (to prevent duplicate documentation).
* \{
*/
/* MPI / BIGNUM options */
//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */