From d7cea0b8f50ee9cc698211f4fbf8ad5fca5812ad Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Thu, 22 Aug 2019 10:51:25 +0530 Subject: [PATCH] Fix some broken doc links Replace L<> link to header-file with a C<> reference. Change some broken L links to L. 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 Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10100) --- doc/man1/openssl-mac.pod | 4 ++-- doc/man3/EVP_EncryptInit.pod | 24 +++++++++---------- doc/man3/EVP_MAC.pod | 14 +++++------ doc/man3/{EVP_aes.pod => EVP_aes_128_gcm.pod} | 0 .../{EVP_aria.pod => EVP_aria_128_gcm.pod} | 0 ..._camellia.pod => EVP_camellia_128_ecb.pod} | 0 doc/man3/{EVP_des.pod => EVP_des_cbc.pod} | 0 doc/man7/EVP_MAC-KMAC.pod | 2 +- doc/man7/openssl-core.h.pod | 4 ++-- doc/man7/provider-cipher.pod | 2 +- doc/man7/provider-digest.pod | 4 ++-- doc/man7/provider-keyexch.pod | 2 +- doc/man7/provider-mac.pod | 2 +- doc/man7/provider-signature.pod | 2 +- 14 files changed, 30 insertions(+), 30 deletions(-) rename doc/man3/{EVP_aes.pod => EVP_aes_128_gcm.pod} (100%) rename doc/man3/{EVP_aria.pod => EVP_aria_128_gcm.pod} (100%) rename doc/man3/{EVP_camellia.pod => EVP_camellia_128_ecb.pod} (100%) rename doc/man3/{EVP_des.pod => EVP_des_cbc.pod} (100%) 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, L, L, L, -L, -L +L, +L =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 Supported ciphers are listed in: -L, -L, -L, -L, -L, +L, +L, +L, +L, +L, L, -L, -L, -L, -L, +L, +L, +L, +L, L, -L, -L, -L +L, +L, +L =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 L, -L, -L, -L, -L, -L, -L, -L +L, +L, +L, +L, +L, +L, +L =head1 HISTORY diff --git a/doc/man3/EVP_aes.pod b/doc/man3/EVP_aes_128_gcm.pod similarity index 100% rename from doc/man3/EVP_aes.pod rename to doc/man3/EVP_aes_128_gcm.pod diff --git a/doc/man3/EVP_aria.pod b/doc/man3/EVP_aria_128_gcm.pod similarity index 100% rename from doc/man3/EVP_aria.pod rename to doc/man3/EVP_aria_128_gcm.pod diff --git a/doc/man3/EVP_camellia.pod b/doc/man3/EVP_camellia_128_ecb.pod similarity index 100% rename from doc/man3/EVP_camellia.pod rename to doc/man3/EVP_camellia_128_ecb.pod diff --git a/doc/man3/EVP_des.pod b/doc/man3/EVP_des_cbc.pod similarity index 100% rename from doc/man3/EVP_des.pod rename to 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 header file defines a number of public types that +The F<< >> 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. +signatures are defined in L. 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 is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_cipher_freectx() is passed a pointer to the provider side cipher context in the I 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 is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_digest_freectx() is passed a pointer to the provider side digest context in the I parameter. @@ -132,7 +132,7 @@ The digest should not exceed I 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 parameter (see L). +passed in the I parameter (see L). I bytes at I should be digested and the result should be stored at I. The length of the digest should be stored in I<*outl> which should not exceed I 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 is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_keyexch_freectx() is passed a pointer to the provider side key exchange context in the I 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 is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_mac_freectx() is passed a pointer to the provider side mac context in the I 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 is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_signature_freectx() is passed a pointer to the provider side signature context in the I parameter. -- 2.25.1