From 1b2a8836c4cf67c47cadcb77bd05e82e2c5c5277 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bence=20Sz=C3=A9pk=C3=BAti?= Date: Mon, 28 Jun 2021 10:26:11 +0100 Subject: [PATCH] Correct documentation references to Mbed TLS MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Use the correct formatting of the product name in the documentation. Signed-off-by: Bence Szépkúti --- ChangeLog.d/split-config.txt | 6 +++--- docs/3.0-migration-guide.d/split_config.md | 6 +++--- include/mbedtls/build_info.h | 2 +- include/mbedtls/mbedtls_config.h | 2 +- include/mbedtls/version.h | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/ChangeLog.d/split-config.txt b/ChangeLog.d/split-config.txt index 5d1201c8a..f66dc93a8 100644 --- a/ChangeLog.d/split-config.txt +++ b/ChangeLog.d/split-config.txt @@ -6,8 +6,8 @@ Changes build_info.h. * The handling of MBEDTLS_CONFIG_FILE has been moved into build_info.h. * A config file version symbol, MBEDTLS_CONFIG_VERSION was introduced. - Defining it to a particular value will ensure that mbedtls interprets + Defining it to a particular value will ensure that Mbed TLS interprets the config file in a way that's compatible with the config file format - used by the mbedtls release whose MBEDTLS_VERSION_NUMBER has the same + used by the Mbed TLS release whose MBEDTLS_VERSION_NUMBER has the same value. - The only value supported by mbedtls 3.0.0 is 0x03000000. + The only value supported by Mbed TLS 3.0.0 is 0x03000000. diff --git a/docs/3.0-migration-guide.d/split_config.md b/docs/3.0-migration-guide.d/split_config.md index b011ad77c..ced38967d 100644 --- a/docs/3.0-migration-guide.d/split_config.md +++ b/docs/3.0-migration-guide.d/split_config.md @@ -10,8 +10,8 @@ into `build_info.h`, including the handling of the `MBEDTLS_CONFIG_FILE` macro. A config file version symbol, `MBEDTLS_CONFIG_VERSION` was introduced. -Defining it to a particular value will ensure that mbedtls interprets +Defining it to a particular value will ensure that Mbed TLS interprets the config file in a way that's compatible with the config file format -used by the mbedtls release whose `MBEDTLS_VERSION_NUMBER` has the same +used by the Mbed TLS release whose `MBEDTLS_VERSION_NUMBER` has the same value. -The only value supported by mbedtls 3.0.0 is `0x03000000`. +The only value supported by Mbed TLS 3.0.0 is `0x03000000`. diff --git a/include/mbedtls/build_info.h b/include/mbedtls/build_info.h index 771aeb5b0..53327a8c8 100644 --- a/include/mbedtls/build_info.h +++ b/include/mbedtls/build_info.h @@ -28,7 +28,7 @@ /* * This set of compile-time defines can be used to determine the version number - * of the mbed TLS library used. Run-time variables for the same can be found in + * of the Mbed TLS library used. Run-time variables for the same can be found in * version.h */ diff --git a/include/mbedtls/mbedtls_config.h b/include/mbedtls/mbedtls_config.h index 21f0c77a6..3a4189d18 100644 --- a/include/mbedtls/mbedtls_config.h +++ b/include/mbedtls/mbedtls_config.h @@ -28,7 +28,7 @@ * This is an optional version symbol that enables comatibility handling of * config files. * - * It is equal to the #MBEDTLS_VERSION_NUMBER of the mbedtls version that + * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that * introduced the config format we want to be compatible with. */ //#define MBEDTLS_CONFIG_VERSION 0x03000000 diff --git a/include/mbedtls/version.h b/include/mbedtls/version.h index 648db7ed6..773da4a67 100644 --- a/include/mbedtls/version.h +++ b/include/mbedtls/version.h @@ -21,7 +21,7 @@ */ /* * This set of run-time variables can be used to determine the version number of - * the mbed TLS library used. Compile-time version defines for the same can be + * the Mbed TLS library used. Compile-time version defines for the same can be * found in build_info.h */ #ifndef MBEDTLS_VERSION_H