diff options
author | Richard Levitte <levitte@openssl.org> | 2022-12-05 16:59:06 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2022-12-08 07:42:03 +0100 |
commit | c919280f793dc468814587c0f103425def872dcc (patch) | |
tree | 9cdc8557c1c429d76b963257e8d4ae32192454cd | |
parent | 2365be297640d81ef523506ed16142d02c17f520 (diff) |
Replace some boldened types with a corresponding man page link
The types OSSL_DISPATCH, OSSL_ITEM, OSSL_ALGORITHM, OSSL_PARAM,
OSSL_CALLBACK, and OSSL_PASSPHRASE_CALLBACK are described in their own
manual page, so we change every mention of them to links to those pages.
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19842)
(cherry picked from commit 318a9dfa5f7bd1237d2697ad950697d241b8b49f)
42 files changed, 192 insertions, 216 deletions
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod index 591c345193..8bd5594c48 100644 --- a/doc/internal/man3/ossl_provider_new.pod +++ b/doc/internal/man3/ossl_provider_new.pod @@ -301,7 +301,7 @@ I<*result> to 1 or 0 accorddingly. ossl_provider_init_as_child() stores in the library context I<ctx> references to the necessary upcalls for managing child providers. The I<handle> and I<in> -parameters are the B<OSSL_CORE_HANDLE> and B<OSSL_DISPATCH> pointers that were +parameters are the B<OSSL_CORE_HANDLE> and L<OSSL_DISPATCH(3)> pointers that were passed to the provider's B<OSSL_provider_init> function. ossl_provider_deinit_child() deregisters callbacks from the parent library diff --git a/doc/man3/EVP_ASYM_CIPHER_free.pod b/doc/man3/EVP_ASYM_CIPHER_free.pod index 72910a5599..c158ec1ae7 100644 --- a/doc/man3/EVP_ASYM_CIPHER_free.pod +++ b/doc/man3/EVP_ASYM_CIPHER_free.pod @@ -75,7 +75,7 @@ meant for display and human consumption. The description is at the discretion of the I<cipher> implementation. EVP_ASYM_CIPHER_gettable_ctx_params() and EVP_ASYM_CIPHER_settable_ctx_params() -return a constant B<OSSL_PARAM> array that describes the names and types of key +return a constant L<OSSL_PARAM(3)> array that describes the names and types of key parameters that can be retrieved or set by a key encryption algorithm using L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>. @@ -90,7 +90,7 @@ EVP_ASYM_CIPHER_names_do_all() returns 1 if the callback was called for all names. A return value of 0 means that the callback was not called for any names. EVP_ASYM_CIPHER_gettable_ctx_params() and EVP_ASYM_CIPHER_settable_ctx_params() -return a constant B<OSSL_PARAM> array or NULL on error. +return a constant L<OSSL_PARAM(3)> array or NULL on error. =head1 SEE ALSO diff --git a/doc/man3/EVP_DigestInit.pod b/doc/man3/EVP_DigestInit.pod index 5b9d75b704..c8099f7aa3 100644 --- a/doc/man3/EVP_DigestInit.pod +++ b/doc/man3/EVP_DigestInit.pod @@ -207,27 +207,24 @@ See L</PARAMETERS> below for more information. =item EVP_MD_gettable_params() -Get a constant B<OSSL_PARAM> array that describes the retrievable parameters -that can be used with EVP_MD_get_params(). See L<OSSL_PARAM(3)> for the -use of B<OSSL_PARAM> as a parameter descriptor. +Get a constant L<OSSL_PARAM(3)> array that describes the retrievable parameters +that can be used with EVP_MD_get_params(). =item EVP_MD_gettable_ctx_params(), EVP_MD_CTX_gettable_params() -Get a constant B<OSSL_PARAM> array that describes the retrievable parameters +Get a constant L<OSSL_PARAM(3)> array that describes the retrievable parameters that can be used with EVP_MD_CTX_get_params(). EVP_MD_gettable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_MD_CTX_gettable_params() returns the parameters that can be retrieved -in the context's current state. See L<OSSL_PARAM(3)> for the use of -B<OSSL_PARAM> as a parameter descriptor. +in the context's current state. =item EVP_MD_settable_ctx_params(), EVP_MD_CTX_settable_params() -Get a constant B<OSSL_PARAM> array that describes the settable parameters +Get a constant L<OSSL_PARAM(3)> array that describes the settable parameters that can be used with EVP_MD_CTX_set_params(). EVP_MD_settable_ctx_params() returns the parameters that can be set from the algorithm, whereas EVP_MD_CTX_settable_params() returns the parameters that can be set in the -context's current state. See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> -as a parameter descriptor. +context's current state. =item EVP_MD_CTX_set_flags(), EVP_MD_CTX_clear_flags(), EVP_MD_CTX_test_flags() @@ -589,7 +586,7 @@ Returns 1 if successful or 0 for failure. =item EVP_MD_CTX_settable_params(), EVP_MD_CTX_gettable_params() -Return an array of constant B<OSSL_PARAM>s, or NULL if there is none +Return an array of constant L<OSSL_PARAM(3)>s, or NULL if there is none to get. =item EVP_MD_CTX_copy_ex() diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index f774d7c283..7556176bad 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -316,27 +316,24 @@ See L</PARAMETERS> below for more information. =item EVP_CIPHER_gettable_params() -Get a constant B<OSSL_PARAM> array that describes the retrievable parameters -that can be used with EVP_CIPHER_get_params(). See L<OSSL_PARAM(3)> for the -use of B<OSSL_PARAM> as a parameter descriptor. +Get a constant L<OSSL_PARAM(3)> array that describes the retrievable parameters +that can be used with EVP_CIPHER_get_params(). =item EVP_CIPHER_gettable_ctx_params() and EVP_CIPHER_CTX_gettable_params() -Get a constant B<OSSL_PARAM> array that describes the retrievable parameters +Get a constant L<OSSL_PARAM(3)> array that describes the retrievable parameters that can be used with EVP_CIPHER_CTX_get_params(). EVP_CIPHER_gettable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_CIPHER_CTX_gettable_params() returns the parameters that can be retrieved in the context's current state. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. =item EVP_CIPHER_settable_ctx_params() and EVP_CIPHER_CTX_settable_params() -Get a constant B<OSSL_PARAM> array that describes the settable parameters +Get a constant L<OSSL_PARAM(3)> array that describes the settable parameters that can be used with EVP_CIPHER_CTX_set_params(). EVP_CIPHER_settable_ctx_params() returns the parameters that can be set from the algorithm, whereas EVP_CIPHER_CTX_settable_params() returns the parameters that can be set in the context's current state. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. =item EVP_EncryptInit_ex2() @@ -640,7 +637,7 @@ See L<OSSL_PARAM(3)> for information about passing parameters. When EVP_CIPHER_fetch() is called it internally calls EVP_CIPHER_get_params() and caches the results. -EVP_CIPHER_get_params() can be used with the following B<OSSL_PARAM> keys: +EVP_CIPHER_get_params() can be used with the following L<OSSL_PARAM(3)> keys: =over 4 @@ -711,7 +708,7 @@ all other OpenSSL ciphers return 0. =head2 Gettable and Settable EVP_CIPHER_CTX parameters -The following B<OSSL_PARAM> keys can be used with both EVP_CIPHER_CTX_get_params() +The following L<OSSL_PARAM(3)> keys can be used with both EVP_CIPHER_CTX_get_params() and EVP_CIPHER_CTX_set_params(). =over 4 @@ -802,7 +799,7 @@ cipher operation (either 4 or 8 records). =head2 Gettable EVP_CIPHER_CTX parameters -The following B<OSSL_PARAM> keys can be used with EVP_CIPHER_CTX_get_params(): +The following L<OSSL_PARAM(3)> keys can be used with EVP_CIPHER_CTX_get_params(): =over 4 @@ -871,7 +868,7 @@ Used to pass the TLS MAC data. =head2 Settable EVP_CIPHER_CTX parameters -The following B<OSSL_PARAM> keys can be used with EVP_CIPHER_CTX_set_params(): +The following L<OSSL_PARAM(3)> keys can be used with EVP_CIPHER_CTX_set_params(): =over 4 diff --git a/doc/man3/EVP_KDF.pod b/doc/man3/EVP_KDF.pod index a8cc83324e..3b4e2b79aa 100644 --- a/doc/man3/EVP_KDF.pod +++ b/doc/man3/EVP_KDF.pod @@ -131,26 +131,23 @@ simply ignored. Also, what happens when a needed parameter isn't passed down is defined by the implementation. -EVP_KDF_gettable_params() returns an B<OSSL_PARAM> array that describes +EVP_KDF_gettable_params() returns an L<OSSL_PARAM(3)> array that describes the retrievable and settable parameters. EVP_KDF_gettable_params() returns parameters that can be used with EVP_KDF_get_params(). -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. EVP_KDF_gettable_ctx_params() and EVP_KDF_CTX_gettable_params() -return constant B<OSSL_PARAM> arrays that describe the retrievable +return constant L<OSSL_PARAM(3)> arrays that describe the retrievable parameters that can be used with EVP_KDF_CTX_get_params(). EVP_KDF_gettable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_KDF_CTX_gettable_params() returns the parameters that can be retrieved in the context's current state. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. EVP_KDF_settable_ctx_params() and EVP_KDF_CTX_settable_params() return -constant B<OSSL_PARAM> arrays that describe the settable parameters that +constant L<OSSL_PARAM(3)> arrays that describe the settable parameters that can be used with EVP_KDF_CTX_set_params(). EVP_KDF_settable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_KDF_CTX_settable_params() returns the parameters that can -be retrieved in the context's current state. See L<OSSL_PARAM(3)> -for the use of B<OSSL_PARAM> as a parameter descriptor. +be retrieved in the context's current state. =head2 Information functions diff --git a/doc/man3/EVP_KEM_free.pod b/doc/man3/EVP_KEM_free.pod index e77b89d3b9..575abc5f57 100644 --- a/doc/man3/EVP_KEM_free.pod +++ b/doc/man3/EVP_KEM_free.pod @@ -68,7 +68,7 @@ display and human consumption. The description is at the discretion of the I<kem> implementation. EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return -a constant B<OSSL_PARAM> array that describes the names and types of key +a constant L<OSSL_PARAM(3)> array that describes the names and types of key parameters that can be retrieved or set by a key encapsulation algorithm using L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>. @@ -83,7 +83,7 @@ EVP_KEM_names_do_all() returns 1 if the callback was called for all names. A return value of 0 means that the callback was not called for any names. EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return -a constant B<OSSL_PARAM> array or NULL on error. +a constant L<OSSL_PARAM(3)> array or NULL on error. =head1 SEE ALSO diff --git a/doc/man3/EVP_KEYEXCH_free.pod b/doc/man3/EVP_KEYEXCH_free.pod index 42c7e1289c..272855ccb3 100644 --- a/doc/man3/EVP_KEYEXCH_free.pod +++ b/doc/man3/EVP_KEYEXCH_free.pod @@ -71,7 +71,7 @@ of the implementations, calls I<fn> with the implementation method and I<data> as arguments. EVP_KEYEXCH_gettable_ctx_params() and EVP_KEYEXCH_settable_ctx_params() return -a constant B<OSSL_PARAM> array that describes the names and types of key +a constant L<OSSL_PARAM(3)> array that describes the names and types of key parameters that can be retrieved or set by a key exchange algorithm using L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>. @@ -89,7 +89,7 @@ EVP_KEYEXCH_is_a() returns 1 of I<exchange> was identifiable, otherwise 0. EVP_KEYEXCH_gettable_ctx_params() and EVP_KEYEXCH_settable_ctx_params() return -a constant B<OSSL_PARAM> array or NULL on error. +a constant L<OSSL_PARAM(3)> array or NULL on error. =head1 SEE ALSO diff --git a/doc/man3/EVP_KEYMGMT.pod b/doc/man3/EVP_KEYMGMT.pod index 6b6e117369..f81fc9efb0 100644 --- a/doc/man3/EVP_KEYMGMT.pod +++ b/doc/man3/EVP_KEYMGMT.pod @@ -88,12 +88,11 @@ of the implementations, calls I<fn> with the implementation method and I<data> as arguments. EVP_KEYMGMT_gettable_params() and EVP_KEYMGMT_settable_params() return a -constant B<OSSL_PARAM> array that describes the names and types of key +constant L<OSSL_PARAM(3)> array that describes the names and types of key parameters that can be retrieved or set. EVP_KEYMGMT_gettable_params() is used by L<EVP_PKEY_gettable_params(3)>. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. -EVP_KEYMGMT_gen_settable_params() returns a constant B<OSSL_PARAM> array that +EVP_KEYMGMT_gen_settable_params() returns a constant L<OSSL_PARAM(3)> array that describes the names and types of key generation parameters that can be set via L<EVP_PKEY_CTX_set_params(3)>. @@ -128,7 +127,7 @@ EVP_KEYMGMT_get0_description() returns a pointer to a decription, or NULL if there isn't one. EVP_KEYMGMT_gettable_params(), EVP_KEYMGMT_settable_params() and -EVP_KEYMGMT_gen_settable_params() return a constant B<OSSL_PARAM> array or +EVP_KEYMGMT_gen_settable_params() return a constant L<OSSL_PARAM(3)> array or NULL on error. =head1 SEE ALSO diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index 289cbda757..13482ac5e1 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -187,26 +187,23 @@ simply ignored. Also, what happens when a needed parameter isn't passed down is defined by the implementation. -EVP_MAC_gettable_params() returns an B<OSSL_PARAM> array that describes +EVP_MAC_gettable_params() returns an L<OSSL_PARAM(3)> array that describes the retrievable and settable parameters. EVP_MAC_gettable_params() returns parameters that can be used with EVP_MAC_get_params(). -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. EVP_MAC_gettable_ctx_params() and EVP_MAC_CTX_gettable_params() -return constant B<OSSL_PARAM> arrays that describe the retrievable +return constant L<OSSL_PARAM(3)> arrays that describe the retrievable parameters that can be used with EVP_MAC_CTX_get_params(). EVP_MAC_gettable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_MAC_CTX_gettable_params() returns the parameters that can be retrieved in the context's current state. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. EVP_MAC_settable_ctx_params() and EVP_MAC_CTX_settable_params() return -constant B<OSSL_PARAM> arrays that describe the settable parameters that +constant L<OSSL_PARAM(3)> arrays that describe the settable parameters that can be used with EVP_MAC_CTX_set_params(). EVP_MAC_settable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_MAC_CTX_settable_params() returns the parameters that can -be retrieved in the context's current state. See L<OSSL_PARAM(3)> -for the use of B<OSSL_PARAM> as a parameter descriptor. +be retrieved in the context's current state. =head2 Information functions diff --git a/doc/man3/EVP_PKEY_CTX_set_params.pod b/doc/man3/EVP_PKEY_CTX_set_params.pod index b8855c2670..c02151654c 100644 --- a/doc/man3/EVP_PKEY_CTX_set_params.pod +++ b/doc/man3/EVP_PKEY_CTX_set_params.pod @@ -30,11 +30,10 @@ These methods replace the EVP_PKEY_CTX_ctrl() mechanism. (EVP_PKEY_CTX_ctrl now calls these methods internally to interact with providers). EVP_PKEY_CTX_gettable_params() and EVP_PKEY_CTX_settable_params() get a -constant B<OSSL_PARAM> array that describes the gettable and +constant L<OSSL_PARAM(3)> array that describes the gettable and settable parameters for the current algorithm implementation, i.e. parameters that can be used with EVP_PKEY_CTX_get_params() and EVP_PKEY_CTX_set_params() respectively. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor. These functions must only be called after the EVP_PKEY_CTX has been initialised for use in an operation. diff --git a/doc/man3/EVP_PKEY_fromdata.pod b/doc/man3/EVP_PKEY_fromdata.pod index 096ecc601f..3e9e06d1a2 100644 --- a/doc/man3/EVP_PKEY_fromdata.pod +++ b/doc/man3/EVP_PKEY_fromdata.pod @@ -48,10 +48,9 @@ and L<B<EVP_PKEY-ED25519>(7)|EVP_PKEY-ED25519(7)/Common X25519, X448, ED25519 an =for comment the awful list of links above is made this way so we get nice rendering as a man-page while still getting proper links in HTML -EVP_PKEY_fromdata_settable() gets a constant B<OSSL_PARAM> array that describes +EVP_PKEY_fromdata_settable() gets a constant L<OSSL_PARAM(3)> array that describes the settable parameters that can be used with EVP_PKEY_fromdata(). I<selection> is described in L</Selections>. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor. Parameters in the I<params> array that are not among the settable parameters for the given I<selection> are ignored. diff --git a/doc/man3/EVP_PKEY_gettable_params.pod b/doc/man3/EVP_PKEY_gettable_params.pod index 1afda9c19b..b51e4c4de1 100644 --- a/doc/man3/EVP_PKEY_gettable_params.pod +++ b/doc/man3/EVP_PKEY_gettable_params.pod @@ -29,15 +29,15 @@ EVP_PKEY_get_octet_string_param =head1 DESCRIPTION +See L<OSSL_PARAM(3)> for information about parameters. + EVP_PKEY_get_params() retrieves parameters from the key I<pkey>, according to the contents of I<params>. -See L<OSSL_PARAM(3)> for information about parameters. EVP_PKEY_gettable_params() returns a constant list of I<params> indicating the names and types of key parameters that can be retrieved. -See L<OSSL_PARAM(3)> for information about parameters. -An B<OSSL_PARAM> of type B<OSSL_PARAM_INTEGER> or +An L<OSSL_PARAM(3)> of type B<OSSL_PARAM_INTEGER> or B<OSSL_PARAM_UNSIGNED_INTEGER> is of arbitrary length. Such a parameter can be obtained using any of the functions EVP_PKEY_get_int_param(), EVP_PKEY_get_size_t_param() or EVP_PKEY_get_bn_param(). Attempting to diff --git a/doc/man3/EVP_PKEY_todata.pod b/doc/man3/EVP_PKEY_todata.pod index 98ae484755..dedfb1b0cf 100644 --- a/doc/man3/EVP_PKEY_todata.pod +++ b/doc/man3/EVP_PKEY_todata.pod @@ -16,7 +16,7 @@ EVP_PKEY_todata, EVP_PKEY_export =head1 DESCRIPTION The functions described here are used to extract B<EVP_PKEY> key values as an -array of B<OSSL_PARAM>. +array of L<OSSL_PARAM(3)>. EVP_PKEY_todata() extracts values from a key I<pkey> using the I<selection>. I<selection> is described in L<EVP_PKEY_fromdata(3)/Selections>. @@ -26,7 +26,7 @@ I<*params>. EVP_PKEY_export() is similiar to EVP_PKEY_todata() but uses a callback I<export_cb> that gets passed the value of I<export_cbarg>. See L<openssl-core.h(7)> for more information about the callback. Note that the -B<OSSL_PARAM> array that is passed to the callback is not persistent after the +L<OSSL_PARAM(3)> array that is passed to the callback is not persistent after the callback returns. The user must preserve the items of interest, or use EVP_PKEY_todata() if persistence is required. diff --git a/doc/man3/EVP_RAND.pod b/doc/man3/EVP_RAND.pod index f21b2f69d7..a4d72b7043 100644 --- a/doc/man3/EVP_RAND.pod +++ b/doc/man3/EVP_RAND.pod @@ -186,26 +186,23 @@ simply ignored. Also, what happens when a needed parameter isn't passed down is defined by the implementation. -EVP_RAND_gettable_params() returns an B<OSSL_PARAM> array that describes +EVP_RAND_gettable_params() returns an L<OSSL_PARAM(3)> array that describes the retrievable and settable parameters. EVP_RAND_gettable_params() returns -parameters that can be used with EVP_RAND_get_params(). See L<OSSL_PARAM(3)> -for the use of B<OSSL_PARAM> as a parameter descriptor. +parameters that can be used with EVP_RAND_get_params(). EVP_RAND_gettable_ctx_params() and EVP_RAND_CTX_gettable_params() return -constant B<OSSL_PARAM> arrays that describe the retrievable parameters that +constant L<OSSL_PARAM(3)> arrays that describe the retrievable parameters that can be used with EVP_RAND_CTX_get_params(). EVP_RAND_gettable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_RAND_CTX_gettable_params() returns the parameters that can be retrieved -in the context's current state. See L<OSSL_PARAM(3)> for the use of -B<OSSL_PARAM> as a parameter descriptor. +in the context's current state. EVP_RAND_settable_ctx_params() and EVP_RAND_CTX_settable_params() return -constant B<OSSL_PARAM> arrays that describe the settable parameters that +constant L<OSSL_PARAM(3)> arrays that describe the settable parameters that can be used with EVP_RAND_CTX_set_params(). EVP_RAND_settable_ctx_params() returns the parameters that can be retrieved from the algorithm, whereas EVP_RAND_CTX_settable_params() returns the parameters that can be retrieved -in the context's current state. See L<OSSL_PARAM(3)> for the use of -B<OSSL_PARAM> as a parameter descriptor. +in the context's current state. =head2 Information functions diff --git a/doc/man3/EVP_SIGNATURE.pod b/doc/man3/EVP_SIGNATURE.pod index 9fb389e7ae..6005220853 100644 --- a/doc/man3/EVP_SIGNATURE.pod +++ b/doc/man3/EVP_SIGNATURE.pod @@ -79,7 +79,7 @@ meant for display and human consumption. The description is at the discretion of the I<signature> implementation. EVP_SIGNATURE_gettable_ctx_params() and EVP_SIGNATURE_settable_ctx_params() -return a constant B<OSSL_PARAM> array that describes the names and types of key +return a constant L<OSSL_PARAM(3)> array that describes the names and types of key parameters that can be retrieved or set by a signature algorithm using L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>. @@ -94,7 +94,7 @@ EVP_SIGNATURE_names_do_all() returns 1 if the callback was called for all names. A return value of 0 means that the callback was not called for any names. EVP_SIGNATURE_gettable_ctx_params() and EVP_SIGNATURE_settable_ctx_params() -return a constant B<OSSL_PARAM> array or NULL on error. +return a constant L<OSSL_PARAM(3)> array or NULL on error. =head1 SEE ALSO diff --git a/doc/man3/OSSL_CALLBACK.pod b/doc/man3/OSSL_CALLBACK.pod index 2aef06cfd1..5fa8a8f089 100644 --- a/doc/man3/OSSL_CALLBACK.pod +++ b/doc/man3/OSSL_CALLBACK.pod @@ -31,7 +31,7 @@ simply be passed back to the callback function when it's called. =item B<OSSL_CALLBACK> This is a generic callback function. When calling this callback function, -the caller is expected to build an B<OSSL_PARAM> array of data it wants or +the caller is expected to build an L<OSSL_PARAM(3)> array of data it wants or is expected to pass back, and pass that as I<params>, as well as the opaque data pointer it received, as I<arg>. @@ -43,7 +43,7 @@ store the pass phrase needs to be given with I<pass>, and its size with I<pass_size>. The length of the prompted pass phrase will be given back in I<*pass_len>. -Additional parameters can be passed with the B<OSSL_PARAM> array I<params>, +Additional parameters can be passed with the L<OSSL_PARAM(3)> array I<params>, =back diff --git a/doc/man3/OSSL_DECODER_CTX_new_for_pkey.pod b/doc/man3/OSSL_DECODER_CTX_new_for_pkey.pod index 5a01a19ebe..213791404c 100644 --- a/doc/man3/OSSL_DECODER_CTX_new_for_pkey.pod +++ b/doc/man3/OSSL_DECODER_CTX_new_for_pkey.pod @@ -78,10 +78,10 @@ callback may be specified with the following functions. OSSL_DECODER_CTX_set_pem_password_cb(), OSSL_DECODER_CTX_set_passphrase_ui() and OSSL_DECODER_CTX_set_passphrase_cb() set up a callback method that the implementation can use to prompt for a pass phrase, giving the caller the -choice of prefered pass phrase callback form. These are called indirectly, -through an internal B<OSSL_PASSPHRASE_CALLBACK> function. +choice of preferred pass phrase callback form. These are called indirectly, +through an internal L<OSSL_PASSPHRASE_CALLBACK(3)> function. -The internal B<OSSL_PASSPHRASE_CALLBACK> function caches the pass phrase, to +The internal L<OSSL_PASSPHRASE_CALLBACK(3)> function caches the pass phrase, to be re-used in all decodings that are performed in the same decoding run (for example, within one L<OSSL_DECODER_from_bio(3)> call). diff --git a/doc/man3/OSSL_ENCODER_CTX_new_for_pkey.pod b/doc/man3/OSSL_ENCODER_CTX_new_for_pkey.pod index 9db6e3d2a4..8ba3bdd467 100644 --- a/doc/man3/OSSL_ENCODER_CTX_new_for_pkey.pod +++ b/doc/man3/OSSL_ENCODER_CTX_new_for_pkey.pod @@ -78,8 +78,8 @@ following functions. OSSL_ENCODER_CTX_set_pem_password_cb(), OSSL_ENCODER_CTX_set_passphrase_ui() and OSSL_ENCODER_CTX_set_passphrase_cb() sets up a callback method that the implementation can use to prompt for a pass phrase, giving the caller the -choice of prefered pass phrase callback form. These are called indirectly, -through an internal B<OSSL_PASSPHRASE_CALLBACK> function. +choice of preferred pass phrase callback form. These are called indirectly, +through an internal L<OSSL_PASSPHRASE_CALLBACK(3)> function. =head2 Output types diff --git a/doc/man3/OSSL_PARAM_allocate_from_text.pod b/doc/man3/OSSL_PARAM_allocate_from_text.pod index 80ba555a8f..e6dc2549fd 100644 --- a/doc/man3/OSSL_PARAM_allocate_from_text.pod +++ b/doc/man3/OSSL_PARAM_allocate_from_text.pod @@ -102,7 +102,7 @@ I<paramdefs> and there was no other failure, otherwise 0. The parameter descriptor array comes from functions dedicated to return them. -The following B<OSSL_PARAM> attributes are used: +The following L<OSSL_PARAM(3)> attributes are used: =over 4 diff --git a/doc/man3/OSSL_PARAM_dup.pod b/doc/man3/OSSL_PARAM_dup.pod index 5130c9e1dc..4ae33faf1e 100644 --- a/doc/man3/OSSL_PARAM_dup.pod +++ b/doc/man3/OSSL_PARAM_dup.pod @@ -16,8 +16,8 @@ OSSL_PARAM_dup, OSSL_PARAM_merge, OSSL_PAR |