diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-04 23:09:19 +0200 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2019-10-31 14:26:34 +0100 |
commit | 6e4618a0d7e84e70703d546a194df887fd624727 (patch) | |
tree | 5f1297d73c92eb486c5570dbf7fa9297765ec440 /doc/man3 | |
parent | Infrastructure for templated doc in POD files (diff) | |
download | openssl-6e4618a0d7e84e70703d546a194df887fd624727.tar.xz openssl-6e4618a0d7e84e70703d546a194df887fd624727.zip |
Fix L<> entries without sections
Add sections (almost always "(3)" to L<> references that were missing
them. Among other things, this
Fixes: #10226
Also remove two references to non-existant manpages that have never
existed, and with the 3.0 structure, are unlikely to do so.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10240)
Diffstat (limited to 'doc/man3')
-rw-r--r-- | doc/man3/BIO_get_data.pod | 2 | ||||
-rw-r--r-- | doc/man3/BIO_meth_new.pod | 8 | ||||
-rw-r--r-- | doc/man3/BIO_push.pod | 2 | ||||
-rw-r--r-- | doc/man3/BIO_should_retry.pod | 2 | ||||
-rw-r--r-- | doc/man3/CMS_get0_type.pod | 3 | ||||
-rw-r--r-- | doc/man3/CTLOG_STORE_new.pod | 2 | ||||
-rw-r--r-- | doc/man3/DSA_meth_new.pod | 3 | ||||
-rw-r--r-- | doc/man3/DSA_set_method.pod | 2 | ||||
-rw-r--r-- | doc/man3/EVP_CIPHER_meth_new.pod | 2 | ||||
-rw-r--r-- | doc/man3/EVP_EncryptInit.pod | 2 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_new.pod | 8 | ||||
-rw-r--r-- | doc/man3/EVP_set_default_properties.pod | 2 | ||||
-rw-r--r-- | doc/man3/OSSL_CMP_CTX_new.pod | 3 | ||||
-rw-r--r-- | doc/man3/OSSL_STORE_expect.pod | 2 | ||||
-rw-r--r-- | doc/man3/RSA_meth_new.pod | 3 | ||||
-rw-r--r-- | doc/man3/SCT_print.pod | 2 | ||||
-rw-r--r-- | doc/man3/SSL_CTX_set_client_hello_cb.pod | 2 | ||||
-rw-r--r-- | doc/man3/SSL_CTX_set_ctlog_list_file.pod | 2 | ||||
-rw-r--r-- | doc/man3/SSL_CTX_set_session_ticket_cb.pod | 4 | ||||
-rw-r--r-- | doc/man3/SSL_alloc_buffers.pod | 2 | ||||
-rw-r--r-- | doc/man3/SSL_read_early_data.pod | 2 | ||||
-rw-r--r-- | doc/man3/o2i_SCT_LIST.pod | 4 |
22 files changed, 32 insertions, 32 deletions
diff --git a/doc/man3/BIO_get_data.pod b/doc/man3/BIO_get_data.pod index 31c4635748..aeb6b1c7e9 100644 --- a/doc/man3/BIO_get_data.pod +++ b/doc/man3/BIO_get_data.pod @@ -47,7 +47,7 @@ BIO_get_shutdown() returns the stat of the BIO's shutdown (i.e. BIO_CLOSE) flag. =head1 SEE ALSO -L<bio>, L<BIO_meth_new> +L<bio(7)>, L<BIO_meth_new(3)> =head1 HISTORY diff --git a/doc/man3/BIO_meth_new.pod b/doc/man3/BIO_meth_new.pod index 9045d16777..b2e2c24692 100644 --- a/doc/man3/BIO_meth_new.pod +++ b/doc/man3/BIO_meth_new.pod @@ -60,7 +60,7 @@ BIO_meth_set_callback_ctrl - Routines to build up BIO methods The B<BIO_METHOD> type is a structure used for the implementation of new BIO types. It provides a set of functions used by OpenSSL for the implementation -of the various BIO capabilities. See the L<bio> page for more information. +of the various BIO capabilities. See the L<bio(7)> page for more information. BIO_meth_new() creates a new B<BIO_METHOD> structure. It should be given a unique integer B<type> and a string that represents its B<name>. @@ -72,7 +72,7 @@ include B<BIO_TYPE_BUFFER> and B<BIO_TYPE_CIPHER>. Filter BIOs should have a type which have the "filter" bit set (B<BIO_TYPE_FILTER>). Source/sink BIOs should have the "source/sink" bit set (B<BIO_TYPE_SOURCE_SINK>). File descriptor based BIOs (e.g. socket, fd, connect, accept etc) should additionally have the -"descriptor" bit set (B<BIO_TYPE_DESCRIPTOR>). See the L<BIO_find_type> page for +"descriptor" bit set (B<BIO_TYPE_DESCRIPTOR>). See the L<BIO_find_type(3)> page for more information. BIO_meth_free() destroys a B<BIO_METHOD> structure and frees up any memory @@ -108,7 +108,7 @@ application calling BIO_gets(). The parameters for the function have the same meaning as for BIO_gets(). BIO_meth_get_ctrl() and BIO_meth_set_ctrl() get and set the function used for -processing ctrl messages in the BIO respectively. See the L<BIO_ctrl> page for +processing ctrl messages in the BIO respectively. See the L<BIO_ctrl(3)> page for more information. This function will be called in response to the application calling BIO_ctrl(). The parameters for the function have the same meaning as for BIO_ctrl(). @@ -146,7 +146,7 @@ The B<BIO_meth_get> functions return the corresponding function pointers. =head1 SEE ALSO -L<bio>, L<BIO_find_type>, L<BIO_ctrl>, L<BIO_read_ex>, L<BIO_new> +L<bio(7)>, L<BIO_find_type(3)>, L<BIO_ctrl(3)>, L<BIO_read_ex(3)>, L<BIO_new(3)> =head1 HISTORY diff --git a/doc/man3/BIO_push.pod b/doc/man3/BIO_push.pod index c5919f3cfd..236ac480e0 100644 --- a/doc/man3/BIO_push.pod +++ b/doc/man3/BIO_push.pod @@ -71,7 +71,7 @@ be written to B<md1> as before. =head1 SEE ALSO -L<bio> +L<bio(7)> =head1 HISTORY diff --git a/doc/man3/BIO_should_retry.pod b/doc/man3/BIO_should_retry.pod index 686eef1f04..25d3f2e230 100644 --- a/doc/man3/BIO_should_retry.pod +++ b/doc/man3/BIO_should_retry.pod @@ -128,7 +128,7 @@ BIO_get_retry_reason() returns the reason for a special condition. =head1 SEE ALSO -L<bio> +L<bio(7)> =head1 HISTORY diff --git a/doc/man3/CMS_get0_type.pod b/doc/man3/CMS_get0_type.pod index 986154fc71..12c2e650a8 100644 --- a/doc/man3/CMS_get0_type.pod +++ b/doc/man3/CMS_get0_type.pod @@ -20,7 +20,8 @@ an ASN1_OBJECT pointer. An application can then decide how to process the CMS_ContentInfo structure based on this value. CMS_set1_eContentType() sets the embedded content type of a CMS_ContentInfo -structure. It should be called with CMS functions (such as L<CMS_sign>, L<CMS_encrypt>) +structure. It should be called with CMS functions (such as L<CMS_sign(3)>, +L<CMS_encrypt(3)>) with the B<CMS_PARTIAL> flag and B<before> the structure is finalised, otherwise the results are undefined. diff --git a/doc/man3/CTLOG_STORE_new.pod b/doc/man3/CTLOG_STORE_new.pod index 24919c539b..5b5d8a1ba6 100644 --- a/doc/man3/CTLOG_STORE_new.pod +++ b/doc/man3/CTLOG_STORE_new.pod @@ -25,7 +25,7 @@ logs). The list can be loaded from one or more files and then searched by LogID CTLOG_STORE_new() creates an empty list of CT logs. This is then populated by CTLOG_STORE_load_default_file() or CTLOG_STORE_load_file(). CTLOG_STORE_load_default_file() loads from the default file, which is named -"ct_log_list.cnf" in OPENSSLDIR (see the output of L<version>). This can be +"ct_log_list.cnf" in OPENSSLDIR (see the output of L<openssl-version(1)>). This can be overridden using an environment variable named "CTLOG_FILE". CTLOG_STORE_load_file() loads from a caller-specified file path instead. Both of these functions append any loaded CT logs to the CTLOG_STORE. diff --git a/doc/man3/DSA_meth_new.pod b/doc/man3/DSA_meth_new.pod index bdf3f293d4..c5e6ccd052 100644 --- a/doc/man3/DSA_meth_new.pod +++ b/doc/man3/DSA_meth_new.pod @@ -88,8 +88,7 @@ DSA_meth_set_keygen - Routines to build up DSA methods The B<DSA_METHOD> type is a structure used for the provision of custom DSA implementations. It provides a set of functions used by OpenSSL for the -implementation of the various DSA capabilities. See the L<dsa> page for more -information. +implementation of the various DSA capabilities. DSA_meth_new() creates a new B<DSA_METHOD> structure. It should be given a unique B<name> and a set of B<flags>. The B<name> should be a NULL terminated diff --git a/doc/man3/DSA_set_method.pod b/doc/man3/DSA_set_method.pod index f5c64ef393..0895e7ad0b 100644 --- a/doc/man3/DSA_set_method.pod +++ b/doc/man3/DSA_set_method.pod @@ -49,7 +49,7 @@ be released during the change. It is possible to have DSA keys that only work with certain DSA_METHOD implementations (eg. from an ENGINE module that supports embedded hardware-protected keys), and in such cases attempting to change the DSA_METHOD for the key can have unexpected -results. See L<DSA_meth_new> for information on constructing custom DSA_METHOD +results. See L<DSA_meth_new(3)> for information on constructing custom DSA_METHOD objects; DSA_new_method() allocates and initializes a DSA structure so that B<engine> diff --git a/doc/man3/EVP_CIPHER_meth_new.pod b/doc/man3/EVP_CIPHER_meth_new.pod index 8a6a4b99de..272e80115c 100644 --- a/doc/man3/EVP_CIPHER_meth_new.pod +++ b/doc/man3/EVP_CIPHER_meth_new.pod @@ -234,7 +234,7 @@ respective B<cipher> function. =head1 SEE ALSO -L<EVP_EncryptInit> +L<EVP_EncryptInit(3)> =head1 HISTORY diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index 31e2fdeaf0..46e6a42a28 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -456,7 +456,7 @@ EVP_CIPHER_CTX_rand_key() returns 1 for success. All algorithms have a fixed key length unless otherwise stated. -Refer to L<SEE ALSO> for the full list of ciphers available through the EVP +Refer to L</SEE ALSO> for the full list of ciphers available through the EVP interface. =over 4 diff --git a/doc/man3/EVP_PKEY_new.pod b/doc/man3/EVP_PKEY_new.pod index 8b3b012b1c..3a2034d3dc 100644 --- a/doc/man3/EVP_PKEY_new.pod +++ b/doc/man3/EVP_PKEY_new.pod @@ -95,8 +95,8 @@ general private key without reference to any particular algorithm. The structure returned by EVP_PKEY_new() is empty. To add a private or public key to this empty structure use the appropriate functions described in -L<EVP_PKEY_set1_RSA(3)>, L<EVP_PKEY_set1_DSA>, L<EVP_PKEY_set1_DH> or -L<EVP_PKEY_set1_EC_KEY>. +L<EVP_PKEY_set1_RSA(3)>, L<EVP_PKEY_set1_DSA(3)>, L<EVP_PKEY_set1_DH(3)> or +L<EVP_PKEY_set1_EC_KEY(3)>. =head1 RETURN VALUES @@ -109,8 +109,8 @@ EVP_PKEY_get_raw_public_key() return 1 for success and 0 for failure. =head1 SEE ALSO -L<EVP_PKEY_set1_RSA(3)>, L<EVP_PKEY_set1_DSA>, L<EVP_PKEY_set1_DH> or -L<EVP_PKEY_set1_EC_KEY> +L<EVP_PKEY_set1_RSA(3)>, L<EVP_PKEY_set1_DSA(3)>, L<EVP_PKEY_set1_DH(3)> or +L<EVP_PKEY_set1_EC_KEY(3)> =head1 HISTORY diff --git a/doc/man3/EVP_set_default_properties.pod b/doc/man3/EVP_set_default_properties.pod index 077913c281..6231fde627 100644 --- a/doc/man3/EVP_set_default_properties.pod +++ b/doc/man3/EVP_set_default_properties.pod @@ -34,7 +34,7 @@ The latter adds an error on the error stack. =head1 SEE ALSO -L<EVP_MD_fetch> +L<EVP_MD_fetch(3)> =head1 HISTORY diff --git a/doc/man3/OSSL_CMP_CTX_new.pod b/doc/man3/OSSL_CMP_CTX_new.pod index b4bfc546a4..96d6841fb2 100644 --- a/doc/man3/OSSL_CMP_CTX_new.pod +++ b/doc/man3/OSSL_CMP_CTX_new.pod @@ -532,7 +532,8 @@ CertRepMessage or Revocation Response or error message, or NULL if unset. OSSL_CMP_CTX_get_failInfoCode() returns the error code from the failInfo field of the last received CertRepMessage or Revocation Response or error message. -This is a bit field and the flags for it are specified in L<cmp.h>. +This is a bit field and the flags for it are specified in the header file +F<< <openssl/cmp.h> >>. The flags start with OSSL_CMP_CTX_FAILINFO, for example: OSSL_CMP_CTX_FAILINFO_badAlg. Returns -1 if the failInfoCode field is unset. diff --git a/doc/man3/OSSL_STORE_expect.pod b/doc/man3/OSSL_STORE_expect.pod index 1a270c8490..ac414e9701 100644 --- a/doc/man3/OSSL_STORE_expect.pod +++ b/doc/man3/OSSL_STORE_expect.pod @@ -32,7 +32,7 @@ grained search of objects. OSSL_STORE_supports_search() checks if the loader of the given OSSL_STORE context supports the given search type. -See L<OSSL_STORE_SEARCH/SUPPORTED CRITERION TYPES> for information on the +See L<OSSL_STORE_SEARCH(3)/SUPPORTED CRITERION TYPES> for information on the supported search criterion types. OSSL_STORE_expect() and OSSL_STORE_find I<must> be called before the first diff --git a/doc/man3/RSA_meth_new.pod b/doc/man3/RSA_meth_new.pod index 10eb3e754d..100c64cbce 100644 --- a/doc/man3/RSA_meth_new.pod +++ b/doc/man3/RSA_meth_new.pod @@ -125,8 +125,7 @@ RSA_meth_get_multi_prime_keygen, RSA_meth_set_multi_prime_keygen The B<RSA_METHOD> type is a structure used for the provision of custom RSA implementations. It provides a set of functions used by OpenSSL -for the implementation of the various RSA capabilities. See the L<rsa> -page for more information. +for the implementation of the various RSA capabilities. RSA_meth_new() creates a new B<RSA_METHOD> structure. It should be given a unique B<name> and a set of B<flags>. The B<name> should be a diff --git a/doc/man3/SCT_print.pod b/doc/man3/SCT_print.pod index ead151b99a..c7ace453af 100644 --- a/doc/man3/SCT_print.pod +++ b/doc/man3/SCT_print.pod @@ -16,7 +16,7 @@ Prints Signed Certificate Timestamps in a human-readable way =head1 DESCRIPTION -SCT_print() prints a single Signed Certificate Timestamp (SCT) to a L<bio> in +SCT_print() prints a single Signed Certificate Timestamp (SCT) to a B<BIO> in a human-readable format. SCT_LIST_print() prints an entire list of SCTs in a similar way. A separator can be specified to delimit each SCT in the output. diff --git a/doc/man3/SSL_CTX_set_client_hello_cb.pod b/doc/man3/SSL_CTX_set_client_hello_cb.pod index 002e90f827..f70b147fc5 100644 --- a/doc/man3/SSL_CTX_set_client_hello_cb.pod +++ b/doc/man3/SSL_CTX_set_client_hello_cb.pod @@ -110,7 +110,7 @@ SSL_client_hello_get1_extensions_present() returns 1 on success and 0 on failure =head1 SEE ALSO L<ssl(7)>, L<SSL_CTX_set_tlsext_servername_callback(3)>, -L<SSL_bytes_to_cipher_list> +L<SSL_bytes_to_cipher_list(3)> =head1 HISTORY diff --git a/doc/man3/SSL_CTX_set_ctlog_list_file.pod b/doc/man3/SSL_CTX_set_ctlog_list_file.pod index d99659ba9e..31f82dc51c 100644 --- a/doc/man3/SSL_CTX_set_ctlog_list_file.pod +++ b/doc/man3/SSL_CTX_set_ctlog_list_file.pod @@ -24,7 +24,7 @@ See L<CTLOG_STORE_new(3)> for the file format. =head1 NOTES These functions will not clear the existing CT log list - it will be appended -to. To replace the existing list, use L<SSL_CTX_set0_ctlog_store> first. +to. To replace the existing list, use L<SSL_CTX_set0_ctlog_store(3)> first. If an error occurs whilst parsing a particular log entry in the file, that log entry will be skipped. diff --git a/doc/man3/SSL_CTX_set_session_ticket_cb.pod b/doc/man3/SSL_CTX_set_session_ticket_cb.pod index 409dfc6ed8..8cdb88cc55 100644 --- a/doc/man3/SSL_CTX_set_session_ticket_cb.pod +++ b/doc/man3/SSL_CTX_set_session_ticket_cb.pod @@ -43,7 +43,7 @@ decryption has been attempted and any session ticket application data is available. If ticket decryption was successful then the B<ss> argument contains the session data. The B<keyname> and B<keyname_len> arguments identify the key used to decrypt the session ticket. The B<status> argument is the result of the -ticket decryption. See the L<NOTES> section below for further details. The value +ticket decryption. See the L</NOTES> section below for further details. The value of B<arg> is the same as that given to SSL_CTX_set_session_ticket_cb(). The B<dec_cb> callback is defined as type B<SSL_CTX_decrypt_session_ticket_fn>. @@ -168,7 +168,7 @@ failure. The B<gen_cb> callback must return 1 to continue the connection. A return of 0 will terminate the connection with an INTERNAL_ERROR alert. -The B<dec_cb> callback must return a value as described in L<NOTES> above. +The B<dec_cb> callback must return a value as described in L</NOTES> above. =head1 SEE ALSO diff --git a/doc/man3/SSL_alloc_buffers.pod b/doc/man3/SSL_alloc_buffers.pod index 1bebeeddc9..b6ce1d9075 100644 --- a/doc/man3/SSL_alloc_buffers.pod +++ b/doc/man3/SSL_alloc_buffers.pod @@ -53,7 +53,7 @@ SSL_alloc_buffers(). L<SSL_free(3)>, L<SSL_clear(3)>, L<SSL_new(3)>, L<SSL_CTX_set_mode(3)>, -L<CRYPTO_set_mem_functions> +L<CRYPTO_set_mem_functions(3)> =head1 COPYRIGHT diff --git a/doc/man3/SSL_read_early_data.pod b/doc/man3/SSL_read_early_data.pod index 416feebbe6..4f1593638c 100644 --- a/doc/man3/SSL_read_early_data.pod +++ b/doc/man3/SSL_read_early_data.pod @@ -65,7 +65,7 @@ yet completed the authentication stage of the handshake. Early data has weaker security properties than other data sent over an SSL/TLS connection. In particular the data does not have forward secrecy. There are also -additional considerations around replay attacks (see L<REPLAY PROTECTION> +additional considerations around replay attacks (see L</REPLAY PROTECTION> below). For these reasons extreme care should be exercised when using early data. For specific details, consult the TLS 1.3 specification. diff --git a/doc/man3/o2i_SCT_LIST.pod b/doc/man3/o2i_SCT_LIST.pod index e7ecfae1dc..1c3468a132 100644 --- a/doc/man3/o2i_SCT_LIST.pod +++ b/doc/man3/o2i_SCT_LIST.pod @@ -19,13 +19,13 @@ decode and encode Signed Certificate Timestamp lists in TLS wire format The SCT_LIST and SCT functions are very similar to the i2d and d2i family of functions, except that they convert to and from TLS wire format, as described in -RFC 6962. See L<d2i_SCT_LIST> for more information about how the parameters are +RFC 6962. See L<d2i_SCT_LIST(3)> for more information about how the parameters are treated and the return values. =head1 RETURN VALUES All of the functions have return values consistent with those stated for -L<d2i_SCT_LIST> and L<i2d_SCT_LIST>. +L<d2i_SCT_LIST(3)> and L<i2d_SCT_LIST(3)>. =head1 SEE ALSO |