Merge pull request #6717 from tom-cosgrove-arm/fix-typos-2212

Fix typos prior to release
2022-12-06 15:00:34 +00:00 · 2022-12-06 15:00:34 +00:00 · 92011eef34
commit 92011eef34
parent 98be95563d ed4f59eec3
50 changed files with 81 additions and 81 deletions
--- a/include/mbedtls/asn1write.h
+++ b/include/mbedtls/asn1write.h
@ -352,7 +352,7 @@ int mbedtls_asn1_write_octet_string( unsigned char **p, const unsigned char *sta
 *                  the existing buffer to fit \p val_len.
 *
 * \return          A pointer to the new / existing entry on success.
- * \return          \c NULL if if there was a memory allocation error.
+ * \return          \c NULL if there was a memory allocation error.
 */
 mbedtls_asn1_named_data *mbedtls_asn1_store_named_data( mbedtls_asn1_named_data **list,
                                        const char *oid, size_t oid_len,
--- a/include/mbedtls/check_config.h
+++ b/include/mbedtls/check_config.h
@ -905,7 +905,7 @@

 #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT)     &&                 \
    !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
-#error "MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT defined, but not all prerequsites"
+#error "MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT defined, but not all prerequisites"
 #endif

 #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT) && MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT != 0
--- a/include/mbedtls/config_psa.h
+++ b/include/mbedtls/config_psa.h
@ -7,7 +7,7 @@
 *  those definitions to define symbols used in the library code.
 *
 *  Users and integrators should not edit this file, please edit
- *  include/mbedtls/mbedtls_config.h for MBETLS_XXX settings or
+ *  include/mbedtls/mbedtls_config.h for MBEDTLS_XXX settings or
 *  include/psa/crypto_config.h for PSA_WANT_XXX settings.
 */
 /*
--- a/include/mbedtls/lms.h
+++ b/include/mbedtls/lms.h
@ -58,7 +58,7 @@
 #define MBEDTLS_LMS_TYPE_LEN            (4)
 #define MBEDTLS_LMS_H_TREE_HEIGHT(type) ((type) == MBEDTLS_LMS_SHA256_M32_H10 ? 10u : 0)

-/* The length of a hash output, Currently only imlemented for SHA256.
+/* The length of a hash output, Currently only implemented for SHA256.
 * Max is 32 bytes.
 */
 #define MBEDTLS_LMS_M_NODE_BYTES(type) ((type) == MBEDTLS_LMS_SHA256_M32_H10 ? 32 : 0)
@ -82,7 +82,7 @@ extern "C" {

 /** The Identifier of the LMS parameter set, as per
 * https://www.iana.org/assignments/leighton-micali-signatures/leighton-micali-signatures.xhtml
- * We are only implementing a subset of the types, particularly H10, for the sake of simplicty.
+ * We are only implementing a subset of the types, particularly H10, for the sake of simplicity.
 */
 typedef enum {
    MBEDTLS_LMS_SHA256_M32_H10 = 0x6,
@ -90,7 +90,7 @@ typedef enum {

 /** The Identifier of the LMOTS parameter set, as per
 *  https://www.iana.org/assignments/leighton-micali-signatures/leighton-micali-signatures.xhtml.
- *  We are only implementing a subset of the types, particularly N32_W8, for the sake of simplicty.
+ *  We are only implementing a subset of the types, particularly N32_W8, for the sake of simplicity.
 */
 typedef enum {
    MBEDTLS_LMOTS_SHA256_N32_W8 = 4
--- a/include/mbedtls/mbedtls_config.h
+++ b/include/mbedtls/mbedtls_config.h
@ -1543,7 +1543,7 @@
 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
 * Requires: MBEDTLS_PSA_CRYPTO_C
 *
- * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
+ * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditionally
 * for most operations, if you want it to only use PSA for all crypto
 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
 * operations, and functions that are common with TLS 1.2 (record protection,
--- a/include/mbedtls/pkcs12.h
+++ b/include/mbedtls/pkcs12.h
@ -94,7 +94,7 @@ int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode,
 *                   no byte order mark and with a null terminator (i.e. the
 *                   last two bytes should be 0x00 0x00).
 * \param pwdlen     length of the password (may be 0).
- * \param salt       Salt buffer to use This may only be \c NULL when
+ * \param salt       Salt buffer to use. This may only be \c NULL when
 *                   \p saltlen is 0.
 * \param saltlen    length of the salt (may be zero)
 * \param mbedtls_md mbedtls_md type to use during the derivation
--- a/include/mbedtls/pkcs7.h
+++ b/include/mbedtls/pkcs7.h
@ -245,7 +245,7 @@ int mbedtls_pkcs7_signed_data_verify( mbedtls_pkcs7 *pkcs7,
 * \param hashlen  Length of the hash.
 *
 * \note           This function is different from mbedtls_pkcs7_signed_data_verify()
- *                 in a way that it directly recieves the hash of the data.
+ *                 in a way that it directly receives the hash of the data.
 *
 * \return         0 if the signature verifies, or a negative error code on failure.
 */
--- a/include/mbedtls/rsa.h
+++ b/include/mbedtls/rsa.h
@ -239,7 +239,7 @@ int mbedtls_rsa_import( mbedtls_rsa_context *ctx,
 * \param N        The RSA modulus. This may be \c NULL.
 * \param N_len    The Byte length of \p N; it is ignored if \p N == NULL.
 * \param P        The first prime factor of \p N. This may be \c NULL.
- * \param P_len    The Byte length of \p P; it ns ignored if \p P == NULL.
+ * \param P_len    The Byte length of \p P; it is ignored if \p P == NULL.
 * \param Q        The second prime factor of \p N. This may be \c NULL.
 * \param Q_len    The Byte length of \p Q; it is ignored if \p Q == NULL.
 * \param D        The private exponent. This may be \c NULL.
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@ -2136,7 +2136,7 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
 *                      the `ServerHello` contains the CID extension, too,
 *                      the CID extension will actually be put to use.
 *                    - On the Server, enabling the use of the CID through
- *                      this call implies that that the server will look for
+ *                      this call implies that the server will look for
 *                      the CID extension in a `ClientHello` from the client,
 *                      and, if present, reply with a CID extension in its
 *                      `ServerHello`.
@ -2582,7 +2582,7 @@ static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
 * \note The library stores \c p without accessing it. It is the responsibility
 *       of the caller to ensure that the pointer remains valid.
 *
- * \param ssl            The SSL context context to modify.
+ * \param ssl            The SSL context to modify.
 * \param p              The new value of the user data.
 */
 static inline void mbedtls_ssl_set_user_data_p(
@ -2596,7 +2596,7 @@ static inline void mbedtls_ssl_set_user_data_p(
 *
 * You can retrieve this value later with mbedtls_ssl_get_user_data_n().
 *
- * \param ssl            The SSL context context to modify.
+ * \param ssl            The SSL context to modify.
 * \param n              The new value of the user data.
 */
 static inline void mbedtls_ssl_set_user_data_n(
@ -2613,7 +2613,7 @@ static inline void mbedtls_ssl_set_user_data_n(
 * called. The value is undefined if mbedtls_ssl_set_user_data_n() has
 * been called without a subsequent call to mbedtls_ssl_set_user_data_p().
 *
- * \param ssl            The SSL context context to modify.
+ * \param ssl            The SSL context to modify.
 * \return               The current value of the user data.
 */
 static inline void *mbedtls_ssl_get_user_data_p(
@ -2629,7 +2629,7 @@ static inline void *mbedtls_ssl_get_user_data_p(
 * called. The value is undefined if mbedtls_ssl_set_user_data_p() has
 * been called without a subsequent call to mbedtls_ssl_set_user_data_n().
 *
- * \param ssl            The SSL context context to modify.
+ * \param ssl            The SSL context to modify.
 * \return               The current value of the user data.
 */
 static inline uintptr_t mbedtls_ssl_get_user_data_n(