diff --git a/docs/architecture/config-check-framework.md b/docs/architecture/config-check-framework.md index fdb5c02ad..29db34731 100644 --- a/docs/architecture/config-check-framework.md +++ b/docs/architecture/config-check-framework.md @@ -47,7 +47,7 @@ This section analyses why certain kinds of configurations are bad. Note that not Applications using the library must be built with the same configuration as the library. Otherwise they may make incompatible assumptions leading to undefined behavior at run time. Therefore it is problematic to define configuration options on the compiler command line (`cc -DMBEDTLS_XXX ...`). -The configuration file variables (PROJECT_CONFIG_FILE, and possibly PROJECT_USER_CONFIG_FILE) are exceptions because it makes sense to, for example, compile the library with `MBEDTLS_CONFIG_FILE="../../acme_platform/include/mbedtls_config.h"` (avoiding changes to the source tree and constraints on the include path order) and then install the file as `/usr/include/mbedtls/mbedtls_config.h`. For those, what matters is the content. +The configuration file variables (PROJECT\_CONFIG\_FILE, and possibly PROJECT\_USER\_CONFIG\_FILE) are exceptions because it makes sense to, for example, compile the library with `MBEDTLS_CONFIG_FILE="../../acme_platform/include/mbedtls_config.h"` (avoiding changes to the source tree and constraints on the include path order) and then install the file as `/usr/include/mbedtls/mbedtls_config.h`. For those, what matters is the content. The config check generator script makes it easy to detect if an option was set on the compiler command line. However, many embedded projects compile the whole platform with a single set of compiler options, and those options may include some of our config options. So if we reject command line options, we should provide an official way to bypass accept them. @@ -87,8 +87,8 @@ Options that exist in Mbed TLS 3.6 and Mbed TLS 4.0 should not be considered rem ### Location of the manually written checks -Most manually configuration checks are located in LIBRARY_DIRECTORY/PROJECT_NAME_check_config.h. -This header is included by LIBRARY_DIRECTORY/PROJECT_NAME_config.c. +Most manually configuration checks are located in LIBRARY\_DIRECTORY/PROJECT\_NAME\_check\_config.h. +This header is included by LIBRARY\_DIRECTORY/PROJECT\_NAME_config.c. ### Behavior of the manually written checks @@ -111,8 +111,8 @@ In Mbed TLS 3.x, there were manually written config checks in `LIBRARY_DIRECTORY/PROJECT_NAME_config_check_*.h. -These headers are included by LIBRARY_DIRECTORY/PROJECT_NAME_config.c. +LIBRARY\_DIRECTORY/PROJECT\_NAME\_config\_check\_\*.h. +These headers are included by LIBRARY\_DIRECTORY/PROJECT\_NAME\_config.c. ### Behavior of the generated checks