diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-27 13:26:22 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-09-28 06:33:16 +0200 |
| commit | dfabee82be84f8ac80eede5d552058fbcdf4928d (patch) | |
| tree | b4c59fbe849d95e57cad84078f88dc97ec6d549c /doc/man7/EVP_KDF-HKDF.pod | |
| parent | a39bc4404baa4e065d01efe829a1f26eba737049 (diff) | |
Make doc/man7/ and doc/internal/man3/ conform with man-pages(7)
It's all in the details, from man-pages(7):
Formatting conventions for manual pages describing functions
...
Variable names should, like argument names, be specified in italics.
...
Formatting conventions (general)
...
Special macros, which are usually in uppercase, are in bold.
Exception: don't boldface NULL.
...
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/10034)
Diffstat (limited to 'doc/man7/EVP_KDF-HKDF.pod')
| -rw-r--r-- | doc/man7/EVP_KDF-HKDF.pod | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/man7/EVP_KDF-HKDF.pod b/doc/man7/EVP_KDF-HKDF.pod index 4da887c007..6bb65e21e7 100644 --- a/doc/man7/EVP_KDF-HKDF.pod +++ b/doc/man7/EVP_KDF-HKDF.pod @@ -63,7 +63,7 @@ derived otherwise an error will occur. In this mode calling L<EVP_KDF-derive(3)> will just perform the extract operation. The value returned will be the intermediate fixed-length pseudorandom -key K. The C<keylen> parameter must match the size of K, which can be looked +key K. The I<keylen> parameter must match the size of K, which can be looked up by calling EVP_KDF_size() after setting the mode and digest. The digest, key and salt values must be set before a key is derived otherwise @@ -89,12 +89,12 @@ A context for HKDF can be obtained by calling: EVP_KDF *kdf = EVP_KDF_fetch(NULL, "HKDF", NULL); EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf); -The output length of an HKDF expand operation is specified via the C<keylen> +The output length of an HKDF expand operation is specified via the I<keylen> parameter to the L<EVP_KDF-derive(3)> function. When using -EVP_KDF_HKDF_MODE_EXTRACT_ONLY the C<keylen> parameter must equal the size of +EVP_KDF_HKDF_MODE_EXTRACT_ONLY the I<keylen> parameter must equal the size of the intermediate fixed-length pseudorandom key otherwise an error will occur. For that mode, the fixed output size can be looked up by calling EVP_KDF_size() -after setting the mode and digest on the C<EVP_KDF_CTX>. +after setting the mode and digest on the B<EVP_KDF_CTX>. =head1 EXAMPLES |