From ee2161e8a6174a06c9f4efe6bfc0b76b2eda46fa Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Mon, 23 Sep 2019 10:17:19 +0200 Subject: [PATCH] Some docs cleanup Clean up a few manual pages that we're about to touch, according to conventions found in Linux' man-pages(7); function arguments in descriptions should be in italics, and types, macros and similar should be in bold, with the exception for NULL. Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/9979) --- doc/man3/EVP_KDF.pod | 14 +++++++------- doc/man3/EVP_KEYEXCH_free.pod | 6 +++--- doc/man3/EVP_MAC.pod | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/man3/EVP_KDF.pod b/doc/man3/EVP_KDF.pod index e175124ad0..f3d80a1757 100644 --- a/doc/man3/EVP_KDF.pod +++ b/doc/man3/EVP_KDF.pod @@ -75,7 +75,7 @@ NULL is a valid parameter, for which this function is a no-op. EVP_KDF_CTX_new() creates a new context for the KDF implementation I. -EVP_KDF_CTX_free() frees up the context C. If I is NULL, nothing +EVP_KDF_CTX_free() frees up the context I. If I is NULL, nothing is done. EVP_KDF_CTX_kdf() returns the B associated with the context @@ -86,9 +86,9 @@ I. EVP_KDF_reset() resets the context to the default state as if the context had just been created. -EVP_KDF_derive() derives C bytes of key material and places it in the +EVP_KDF_derive() derives I bytes of key material and places it in the I buffer. If the algorithm produces a fixed amount of output then an -error will occur unless the C parameter is equal to that output size, +error will occur unless the I parameter is equal to that output size, as returned by EVP_KDF_size(). EVP_KDF_get_params() retrieves details about the implementation @@ -211,7 +211,7 @@ The memory size must never exceed what can be given with a B. =head1 RETURN VALUES -EVP_MAC_fetch() returns a pointer to a newly fetched B, or +EVP_KDF_fetch() returns a pointer to a newly fetched B, or NULL if allocation failed. EVP_KDF_name() returns the name for the given I, if it has been @@ -220,14 +220,14 @@ added to the object database. EVP_KDF_provider() returns a pointer to the provider for the KDF, or NULL on error. -EVP_MAC_up_ref() returns 1 on success, 0 on error. +EVP_KDF_up_ref() returns 1 on success, 0 on error. EVP_KDF_CTX_new() returns either the newly allocated -C structure or C if an error occurred. +B structure or NULL if an error occurred. EVP_KDF_CTX_free() and EVP_KDF_reset() do not return a value. -EVP_KDF_size() returns the output size. C is returned to indicate +EVP_KDF_size() returns the output size. B is returned to indicate that the algorithm produces a variable amount of output; 0 to indicate failure. The remaining functions return 1 for success and 0 or a negative value for diff --git a/doc/man3/EVP_KEYEXCH_free.pod b/doc/man3/EVP_KEYEXCH_free.pod index 41926f6b12..6571f9c111 100644 --- a/doc/man3/EVP_KEYEXCH_free.pod +++ b/doc/man3/EVP_KEYEXCH_free.pod @@ -18,8 +18,8 @@ EVP_KEYEXCH_fetch, EVP_KEYEXCH_free, EVP_KEYEXCH_up_ref, EVP_KEYEXCH_provider =head1 DESCRIPTION EVP_KEYEXCH_fetch() fetches the key exchange implementation for the given -B from any provider offering it, within the criteria given -by the B. +I from any provider offering it, within the criteria given +by the I. See L for further information. The returned value must eventually be freed with EVP_KEYEXCH_free(). @@ -37,7 +37,7 @@ EVP_KEYEXCH_provider() returns the provider that I was fetched from. =head1 RETURN VALUES EVP_KEYEXCH_fetch() returns a pointer to a B for success -or B for failure. +or NULL for failure. EVP_KEYEXCH_up_ref() returns 1 for success or 0 otherwise. diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index c2087546ea..256605b508 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -116,10 +116,10 @@ EVP_MAC_update() adds I bytes from I to the MAC input. EVP_MAC_final() does the final computation and stores the result in the memory pointed at by I of size I, and sets the number of bytes written in I<*outl> at. -If I is B or I is too small, then no computation +If I is NULL or I is too small, then no computation is made. To figure out what the output length will be and allocate space for it -dynamically, simply call with I being B and I +dynamically, simply call with I being NULL and I pointing at a valid location, then allocate space and make a second call with I pointing at the allocated space. -- 2.25.1