From fa332bba919d094c1654bbb3be0528b3df6e9023 Mon Sep 17 00:00:00 2001 From: parasssh Date: Wed, 22 Aug 2018 22:42:11 -0700 Subject: [PATCH] Fix typos in documentation. CLA: trivial Reviewed-by: Tim Hudson Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/7038) --- doc/man3/EVP_DigestInit.pod | 2 +- doc/man3/EVP_DigestSignInit.pod | 10 +++++----- doc/man3/EVP_DigestVerifyInit.pod | 2 +- doc/man7/Ed25519.pod | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/man3/EVP_DigestInit.pod b/doc/man3/EVP_DigestInit.pod index 808d79646a..67f4f02196 100644 --- a/doc/man3/EVP_DigestInit.pod +++ b/doc/man3/EVP_DigestInit.pod @@ -278,7 +278,7 @@ EVP_MD_CTX_copy_ex() because they can efficiently reuse a digest context instead of initializing and cleaning it up on each call and allow non default implementations of digests to be specified. -If digest contexts are not cleaned up after use +If digest contexts are not cleaned up after use, memory leaks will occur. EVP_MD_CTX_size(), EVP_MD_CTX_block_size(), EVP_MD_CTX_type(), diff --git a/doc/man3/EVP_DigestSignInit.pod b/doc/man3/EVP_DigestSignInit.pod index 400e89d5f5..19198016e0 100644 --- a/doc/man3/EVP_DigestSignInit.pod +++ b/doc/man3/EVP_DigestSignInit.pod @@ -31,7 +31,7 @@ the signing algorithm supports it. Only EVP_PKEY types that support signing can be used with these functions. This includes MAC algorithms where the MAC generation is considered as a form of -"signing." Built-in EVP_PKEY types supported by these functions are CMAC, +"signing". Built-in EVP_PKEY types supported by these functions are CMAC, Poly1305, DSA, ECDSA, HMAC, RSA, SipHash, Ed25519 and Ed448. Not all digests can be used for all key types. The following combinations apply. @@ -80,10 +80,10 @@ signature context B. This function can be called several times on the same B to include additional data. This function is currently implemented using a macro. -EVP_DigestSignFinal() signs the data in B places the signature in B. +EVP_DigestSignFinal() signs the data in B and places the signature in B. If B is B then the maximum size of the output buffer is written to the B parameter. If B is not B then before the call the -B parameter should contain the length of the B buffer, if the +B parameter should contain the length of the B buffer. If the call is successful the signature is written to B and the amount of data written to B. @@ -95,7 +95,7 @@ EVP_DigestSignFinal(). EVP_DigestSignInit(), EVP_DigestSignUpdate(), EVP_DigestSignaFinal() and EVP_DigestSign() return 1 for success and 0 or a negative value for failure. In -particular a return value of -2 indicates the operation is not supported by the +particular, a return value of -2 indicates the operation is not supported by the public key algorithm. The error codes can be obtained from L. @@ -123,7 +123,7 @@ The call to EVP_DigestSignFinal() internally finalizes a copy of the digest context. This means that calls to EVP_DigestSignUpdate() and EVP_DigestSignFinal() can be called later to digest and sign additional data. -Since only a copy of the digest context is ever finalized the context must +Since only a copy of the digest context is ever finalized, the context must be cleaned up after use by calling EVP_MD_CTX_free() or a memory leak will occur. diff --git a/doc/man3/EVP_DigestVerifyInit.pod b/doc/man3/EVP_DigestVerifyInit.pod index 352ab8462e..e24a925cfb 100644 --- a/doc/man3/EVP_DigestVerifyInit.pod +++ b/doc/man3/EVP_DigestVerifyInit.pod @@ -75,7 +75,7 @@ The call to EVP_DigestVerifyFinal() internally finalizes a copy of the digest context. This means that EVP_VerifyUpdate() and EVP_VerifyFinal() can be called later to digest and verify additional data. -Since only a copy of the digest context is ever finalized the context must +Since only a copy of the digest context is ever finalized, the context must be cleaned up after use by calling EVP_MD_CTX_free() or a memory leak will occur. diff --git a/doc/man7/Ed25519.pod b/doc/man7/Ed25519.pod index 466e543c16..7ed5cf0b55 100644 --- a/doc/man7/Ed25519.pod +++ b/doc/man7/Ed25519.pod @@ -25,7 +25,7 @@ The message to sign or verify must be passed using the one-shot EVP_DigestSign() and EVP_DigestVerify() functions. When calling EVP_DigestSignInit() or EVP_DigestVerifyInit(), the -digest parameter B be set to B. +digest B parameter B be set to B. Applications wishing to sign certificates (or other structures such as CRLs or certificate requests) using Ed25519 or Ed448 can either use X509_sign() -- 2.25.1