diff --git a/include/mbedtls/mbedtls_config.h b/include/mbedtls/mbedtls_config.h index a45598883d..f4a9e3bddf 100644 --- a/include/mbedtls/mbedtls_config.h +++ b/include/mbedtls/mbedtls_config.h @@ -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. */ diff --git a/scripts/config.py b/scripts/config.py index 0ab1e394f0..24c953802b 100755 --- a/scripts/config.py +++ b/scripts/config.py @@ -161,8 +161,16 @@ def is_full_section(section): return section.endswith('support') or section.endswith('modules') def realfull_adapter(_name, active, section): - """Activate all symbols found in the system and feature sections.""" - if not is_full_section(section): + """Activate all symbols found in the global and boolean feature sections. + + 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 True