diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-24 16:40:11 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2020-01-22 18:06:49 +0100 |
commit | fadb57e554cb0b9b7678902a3572740f31bcc279 (patch) | |
tree | 9f46c05cf0fd4f5fa18c8204c0a9607eb4314b5a /doc/man7 | |
parent | 2280685883f7c19a07a55bcc3ddcd11b6cd82056 (diff) |
Fix some missing doc links.
Replace "=for openssl foreign manuals" with simpler syntax, it looks
like the "=for openssl ifdef" construct.
Fix some broken L<> links; add some missing foreign references and fixed
some typo's.
The WARNINGS in dhparam referred to non-existant commands so reword it.
Fixes #10109
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10256)
Diffstat (limited to 'doc/man7')
-rw-r--r-- | doc/man7/EVP_KDF-KRB5KDF.pod | 1 | ||||
-rw-r--r-- | doc/man7/OSSL_PROVIDER-FIPS.pod | 4 | ||||
-rw-r--r-- | doc/man7/openssl-env.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-asym_cipher.pod | 8 | ||||
-rw-r--r-- | doc/man7/provider-keyexch.pod | 4 | ||||
-rw-r--r-- | doc/man7/provider-signature.pod | 6 | ||||
-rw-r--r-- | doc/man7/provider.pod | 4 |
7 files changed, 13 insertions, 16 deletions
diff --git a/doc/man7/EVP_KDF-KRB5KDF.pod b/doc/man7/EVP_KDF-KRB5KDF.pod index 1ac06c493e..9d3f27bb4b 100644 --- a/doc/man7/EVP_KDF-KRB5KDF.pod +++ b/doc/man7/EVP_KDF-KRB5KDF.pod @@ -96,7 +96,6 @@ RFC 3961 =head1 SEE ALSO L<EVP_KDF(3)>, -L<EVP_KDF_CTX_new_id(3)>, L<EVP_KDF_CTX_free(3)>, L<EVP_KDF_ctrl(3)>, L<EVP_KDF_size(3)>, diff --git a/doc/man7/OSSL_PROVIDER-FIPS.pod b/doc/man7/OSSL_PROVIDER-FIPS.pod index a04ce4d6f2..c3768da7bc 100644 --- a/doc/man7/OSSL_PROVIDER-FIPS.pod +++ b/doc/man7/OSSL_PROVIDER-FIPS.pod @@ -15,7 +15,7 @@ accredited testing laboratory. One of the requirements for the FIPS module is self testing. An optional callback mechanism is available to return information to the user using -L<OSSL_SELF_TEST_set_callback(7)>. +L<OSSL_SELF_TEST_set_callback(3)>. The OPENSSL FIPS module uses the following mechanism to provide information about the self tests as they run. @@ -240,7 +240,7 @@ A simple self test callback is shown below for illustrative purposes. L<openssl-fipsinstall(1)>, L<fips_config(5)>, -L<OSSL_SELF_TEST_set_callback(7)>, +L<OSSL_SELF_TEST_set_callback(3)>, L<OSSL_PARAM(3)>, L<openssl-core.h(7)> diff --git a/doc/man7/openssl-env.pod b/doc/man7/openssl-env.pod index ee341a92d1..be89f85172 100644 --- a/doc/man7/openssl-env.pod +++ b/doc/man7/openssl-env.pod @@ -37,7 +37,7 @@ See L<openssl-engine(1)>. =item B<OPENSSL_MALLOC_FD>, B<OPENSSL_MALLOC_FAILURES> If built with debugging, this allows memory allocation to fail. -See L<OPENSSSL_malloc(3)>. +See L<OPENSSL_malloc(3)>. =item B<OPENSSL_MODULES> diff --git a/doc/man7/provider-asym_cipher.pod b/doc/man7/provider-asym_cipher.pod index de615c463f..b442cd5a50 100644 --- a/doc/man7/provider-asym_cipher.pod +++ b/doc/man7/provider-asym_cipher.pod @@ -47,9 +47,9 @@ for further information. The asymmetric cipher (OSSL_OP_ASYM_CIPHER) operation enables providers to implement asymmetric cipher algorithms and make them available to applications -via the API functions L<EVP_PKEY_encrypt_init_ex(3)>, L<EVP_PKEY_encrypt(3)>, -L<EVP_PKEY_decrypt_init_ex(3)>, L<EVP_PKEY_decrypt(3)> (as well -as other related functions). +via the API functions L<EVP_PKEY_encrypt(3)>, +L<EVP_PKEY_decrypt(3)> and +other related functions). All "functions" mentioned here are passed as function pointers between F<libcrypto> and the provider in B<OSSL_DISPATCH> arrays via @@ -108,7 +108,7 @@ structure for holding context information during an asymmetric cipher operation. A pointer to this context will be passed back in a number of the other asymmetric cipher operation function calls. The parameter I<provctx> is the provider context generated during provider -initialisation (see L<provider(3)>). +initialisation (see L<provider(7)>). OP_asym_cipher_freectx() is passed a pointer to the provider side asymmetric cipher context in the I<ctx> parameter. diff --git a/doc/man7/provider-keyexch.pod b/doc/man7/provider-keyexch.pod index aa010daa81..ceb03ec2f0 100644 --- a/doc/man7/provider-keyexch.pod +++ b/doc/man7/provider-keyexch.pod @@ -38,8 +38,8 @@ This documentation is primarily aimed at provider authors. See L<provider(7)> for further information. The key exchange (OSSL_OP_KEYEXCH) operation enables providers to implement key -exchange algorithms and make them available to applications via the API -functions L<EVP_PKEY_derive_init_ex(3)>, and L<EVP_PKEY_derive(3)> (as well as +exchange algorithms and make them available to applications via +L<EVP_PKEY_derive(3)> and other related functions). All "functions" mentioned here are passed as function pointers between diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod index ea98c95ae2..d5f0c396c1 100644 --- a/doc/man7/provider-signature.pod +++ b/doc/man7/provider-signature.pod @@ -51,9 +51,9 @@ for further information. The signature (OSSL_OP_SIGNATURE) operation enables providers to implement signature algorithms and make them available to applications via the API -functions L<EVP_PKEY_sign_init_ex(3)>, L<EVP_PKEY_sign(3)>, -L<EVP_PKEY_verify_init_ex(3)>, L<EVP_PKEY_verify(3)>, -L<EVP_PKEY_verify_recover_init_ex(3)> and L<EVP_PKEY_verify_recover(3)> (as well +functions L<EVP_PKEY_sign(3)>, +L<EVP_PKEY_verify(3)>, +and L<EVP_PKEY_verify_recover(3)> (as well as other related functions). All "functions" mentioned here are passed as function pointers between diff --git a/doc/man7/provider.pod b/doc/man7/provider.pod index 0e9019960d..d2fef9beee 100644 --- a/doc/man7/provider.pod +++ b/doc/man7/provider.pod @@ -217,8 +217,7 @@ When they are used with functions like L<EVP_DigestInit_ex(3)> or L<EVP_CipherInit_ex(3)>, the actual implementation to be used is fetched implicitly using default search criteria. -Implicit fetching can also occur with functions such as -L<EVP_PKEY_derive_init_ex(3)> where a NULL algorithm parameter is +Implicit fetching can also occur when a NULL algorithm parameter is supplied. In this case an algorithm implementation is implicitly fetched using default search criteria and an algorithm name that is consistent with @@ -349,7 +348,6 @@ other providers: =head1 SEE ALSO L<EVP_DigestInit_ex(3)>, L<EVP_EncryptInit_ex(3)>, -L<EVP_PKEY_derive_init_ex(3)>, L<OPENSSL_CTX(3)>, L<EVP_set_default_properties(3)>, L<EVP_MD_fetch(3)>, |