summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2019-08-22 10:51:25 +0530
committerTomas Mraz <tmraz@fedoraproject.org>2019-11-15 17:20:33 +0100
commitd7cea0b8f50ee9cc698211f4fbf8ad5fca5812ad (patch)
tree8a4bd79381c2e59a4bbdc7c59eba0398a7780891 /doc
parent93863030867ad0331bf7f199f8a266ad99ee4cf2 (diff)
Fix some broken doc links
Replace L<> link to header-file with a C<> reference. Change some broken L<provider(3)> links to L<provider(7)>. For consistency, rename four cipher pages to have a specific mode. Fix up all references to any "generic" names to point to specific names. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10100)
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/openssl-mac.pod4
-rw-r--r--doc/man3/EVP_EncryptInit.pod24
-rw-r--r--doc/man3/EVP_MAC.pod14
-rw-r--r--doc/man3/EVP_aes_128_gcm.pod (renamed from doc/man3/EVP_aes.pod)0
-rw-r--r--doc/man3/EVP_aria_128_gcm.pod (renamed from doc/man3/EVP_aria.pod)0
-rw-r--r--doc/man3/EVP_camellia_128_ecb.pod (renamed from doc/man3/EVP_camellia.pod)0
-rw-r--r--doc/man3/EVP_des_cbc.pod (renamed from doc/man3/EVP_des.pod)0
-rw-r--r--doc/man7/EVP_MAC-KMAC.pod2
-rw-r--r--doc/man7/openssl-core.h.pod4
-rw-r--r--doc/man7/provider-cipher.pod2
-rw-r--r--doc/man7/provider-digest.pod4
-rw-r--r--doc/man7/provider-keyexch.pod2
-rw-r--r--doc/man7/provider-mac.pod2
-rw-r--r--doc/man7/provider-signature.pod2
14 files changed, 30 insertions, 30 deletions
diff --git a/doc/man1/openssl-mac.pod b/doc/man1/openssl-mac.pod
index ce2af2d934..f5be58bcb2 100644
--- a/doc/man1/openssl-mac.pod
+++ b/doc/man1/openssl-mac.pod
@@ -147,8 +147,8 @@ L<EVP_MAC-CMAC(7)>,
L<EVP_MAC-GMAC(7)>,
L<EVP_MAC-HMAC(7)>,
L<EVP_MAC-KMAC(7)>,
-L<EVP_MAC-SIPHASH(7)>,
-L<EVP_MAC-POLY1305(7)>
+L<EVP_MAC-Siphash(7)>,
+L<EVP_MAC-Poly1305(7)>
=head1 COPYRIGHT
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod
index 46e6a42a28..1ca3e7478e 100644
--- a/doc/man3/EVP_EncryptInit.pod
+++ b/doc/man3/EVP_EncryptInit.pod
@@ -794,20 +794,20 @@ L<evp(7)>
Supported ciphers are listed in:
-L<EVP_aes(3)>,
-L<EVP_aria(3)>,
-L<EVP_bf(3)>,
-L<EVP_camellia(3)>,
-L<EVP_cast5(3)>,
+L<EVP_aes_128_gcm(3)>,
+L<EVP_aria_128_gcm(3)>,
+L<EVP_bf_cbc(3)>,
+L<EVP_camellia_128_ecb(3)>,
+L<EVP_cast5_cbc(3)>,
L<EVP_chacha20(3)>,
-L<EVP_des(3)>,
-L<EVP_desx(3)>,
-L<EVP_idea(3)>,
-L<EVP_rc2(3)>,
+L<EVP_des_cbc(3)>,
+L<EVP_desx_cbc(3)>,
+L<EVP_idea_cbc(3)>,
+L<EVP_rc2_cbc(3)>,
L<EVP_rc4(3)>,
-L<EVP_rc5(3)>,
-L<EVP_seed(3)>,
-L<EVP_sm4(3)>
+L<EVP_rc5_32_12_16_cbc(3)>,
+L<EVP_seed_cbc(3)>,
+L<EVP_sm4_cbc(3)>
=head1 HISTORY
diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod
index 1081314879..e737d45310 100644
--- a/doc/man3/EVP_MAC.pod
+++ b/doc/man3/EVP_MAC.pod
@@ -370,13 +370,13 @@ F<./foo>)
L<property(7)>
L<OSSL_PARAM(3)>,
-L<EVP_MAC_BLAKE2(7)>,
-L<EVP_MAC_CMAC(7)>,
-L<EVP_MAC_GMAC(7)>,
-L<EVP_MAC_HMAC(7)>,
-L<EVP_MAC_KMAC(7)>,
-L<EVP_MAC_SIPHASH(7)>,
-L<EVP_MAC_POLY1305(7)>
+L<EVP_MAC-BLAKE2(7)>,
+L<EVP_MAC-CMAC(7)>,
+L<EVP_MAC-GMAC(7)>,
+L<EVP_MAC-HMAC(7)>,
+L<EVP_MAC-KMAC(7)>,
+L<EVP_MAC-Siphash(7)>,
+L<EVP_MAC-Poly1305(7)>
=head1 HISTORY
diff --git a/doc/man3/EVP_aes.pod b/doc/man3/EVP_aes_128_gcm.pod
index 1ca893a738..1ca893a738 100644
--- a/doc/man3/EVP_aes.pod
+++ b/doc/man3/EVP_aes_128_gcm.pod
diff --git a/doc/man3/EVP_aria.pod b/doc/man3/EVP_aria_128_gcm.pod
index 6471acb249..6471acb249 100644
--- a/doc/man3/EVP_aria.pod
+++ b/doc/man3/EVP_aria_128_gcm.pod
diff --git a/doc/man3/EVP_camellia.pod b/doc/man3/EVP_camellia_128_ecb.pod
index 4a57f79512..4a57f79512 100644
--- a/doc/man3/EVP_camellia.pod
+++ b/doc/man3/EVP_camellia_128_ecb.pod
diff --git a/doc/man3/EVP_des.pod b/doc/man3/EVP_des_cbc.pod
index d00179eacb..d00179eacb 100644
--- a/doc/man3/EVP_des.pod
+++ b/doc/man3/EVP_des_cbc.pod
diff --git a/doc/man7/EVP_MAC-KMAC.pod b/doc/man7/EVP_MAC-KMAC.pod
index ac94f6b5f7..0801a19781 100644
--- a/doc/man7/EVP_MAC-KMAC.pod
+++ b/doc/man7/EVP_MAC-KMAC.pod
@@ -2,7 +2,7 @@
=head1 NAME
-EVP_MAC-KMAC, EVP_MAC-KMAC256, EVP_MAC-KMAC256
+EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256
- The KMAC EVP_MAC implementations
=head1 DESCRIPTION
diff --git a/doc/man7/openssl-core.h.pod b/doc/man7/openssl-core.h.pod
index 55d53fe262..b5323e9d21 100644
--- a/doc/man7/openssl-core.h.pod
+++ b/doc/man7/openssl-core.h.pod
@@ -10,7 +10,7 @@ openssl/core.h - OpenSSL Core types
=head1 DESCRIPTION
-The <openssl/core.h> header file defines a number of public types that
+The F<< <openssl/core.h> >> header defines a number of public types that
are used to communicate between the OpenSSL libraries and
implementation providers.
These types are designed to minimise the need for intimate knowledge
@@ -30,7 +30,7 @@ Arrays of this type must be terminated with a tuple having function
identity zero and function pointer NULL.
The available function identities and corresponding function
-signatures are defined by L<openssl-core_numbers.h(7)>.
+signatures are defined in L<openssl-core_numbers.h(7)>.
Any function identity not recognised by the recipient of this type
will be ignored.
diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod
index c5415a5441..cd999f880e 100644
--- a/doc/man7/provider-cipher.pod
+++ b/doc/man7/provider-cipher.pod
@@ -112,7 +112,7 @@ structure for holding context information during a cipher operation.
A pointer to this context will be passed back in a number of the other 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_cipher_freectx() is passed a pointer to the provider side cipher context in
the I<cctx> parameter.
diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod
index 159a0e0b76..576ea581b4 100644
--- a/doc/man7/provider-digest.pod
+++ b/doc/man7/provider-digest.pod
@@ -100,7 +100,7 @@ structure for holding context information during a digest operation.
A pointer to this context will be passed back in a number of the other digest
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_digest_freectx() is passed a pointer to the provider side digest context in
the I<dctx> parameter.
@@ -132,7 +132,7 @@ The digest should not exceed I<outsz> bytes.
OP_digest_digest() is a "oneshot" digest function.
No provider side digest context is used.
Instead the provider context that was created during provider initialisation is
-passed in the I<provctx> parameter (see L<provider(3)>).
+passed in the I<provctx> parameter (see L<provider(7)>).
I<inl> bytes at I<in> should be digested and the result should be stored at
I<out>. The length of the digest should be stored in I<*outl> which should not
exceed I<outsz> bytes.
diff --git a/doc/man7/provider-keyexch.pod b/doc/man7/provider-keyexch.pod
index 0f7752cf8f..dc5bdfc005 100644
--- a/doc/man7/provider-keyexch.pod
+++ b/doc/man7/provider-keyexch.pod
@@ -88,7 +88,7 @@ structure for holding context information during a key exchange operation.
A pointer to this context will be passed back in a number of the other key
exchange operation function calls.
The paramater I<provctx> is the provider context generated during provider
-initialisation (see L<provider(3)>).
+initialisation (see L<provider(7)>).
OP_keyexch_freectx() is passed a pointer to the provider side key exchange
context in the I<ctx> parameter.
diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod
index 1a2e43130b..f11ca42d76 100644
--- a/doc/man7/provider-mac.pod
+++ b/doc/man7/provider-mac.pod
@@ -94,7 +94,7 @@ structure for holding context information during a mac operation.
A pointer to this context will be passed back in a number of the other mac
operation function calls.
The paramater I<provctx> is the provider context generated during provider
-initialisation (see L<provider(3)>).
+initialisation (see L<provider(7)>).
OP_mac_freectx() is passed a pointer to the provider side mac context in
the I<mctx> parameter.
diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod
index fa446737bb..48fbe2ce04 100644
--- a/doc/man7/provider-signature.pod
+++ b/doc/man7/provider-signature.pod
@@ -112,7 +112,7 @@ structure for holding context information during a signature operation.
A pointer to this context will be passed back in a number of the other signature
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_signature_freectx() is passed a pointer to the provider side signature
context in the I<ctx> parameter.