yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-22 18:15:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Place MBEDTLS_CONFIG_FILE and such into a new section

Browse Source 
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 690a2ef13c
commit 86198d71e3
2 changed files with 28 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/mbedtls/config.h
View File

@ -3620,7 +3620,7 @@
/** \} name SECTION: mbed TLS modules */ /** \} 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 * This section allows for the setting of module specific sizes and
* configuration options. The default values are already present in the * configuration options. The default values are already present in the
@ -3634,7 +3634,6 @@
* \{ * \{
*/ */
/* Meta configuration */
/** /**
* \def MBEDTLS_CONFIG_FILE * \def MBEDTLS_CONFIG_FILE
* *
@ -3699,6 +3698,23 @@
*/ */
//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null" //#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 */ /* MPI / BIGNUM options */
//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */ //#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */ //#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */

12
scripts/config.py
View File

@ -152,8 +152,16 @@ def is_full_section(section):
return section.endswith('support') or section.endswith('modules') return section.endswith('support') or section.endswith('modules')
def realfull_adapter(_name, active, section): def realfull_adapter(_name, active, section):
"""Activate all symbols found in the system and feature sections.""" """Activate all symbols found in the global and boolean feature sections.
if not is_full_section(section):
This is intended for building the documentation, including the
documentation of settings that are activated by defining an optional
preprocessor macro.
Do not activate definitions in the section containing symbols that are
supposed to be defined and documented in their own module.
"""
if section == 'Module configuration options':
return active return active
return True return True