summaryrefslogtreecommitdiffstats
path: root/doc/man3
diff options
context:
space:
mode:
authorDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2018-12-09 01:02:36 +0100
committerDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2018-12-15 22:27:26 +0100
commitfc5ecaddd0c2aa76dfc8b9c4a7b3686cf2a3a292 (patch)
tree97c10c5573738437fe73eae0f638a3f1b72724a6 /doc/man3
parent6e94b5aecd619afd25e3dc25902952b1b3194edf (diff)
man: harmonize the various formulations in the HISTORY sections
While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
Diffstat (limited to 'doc/man3')
-rw-r--r--doc/man3/ASN1_INTEGER_get_int64.pod2
-rw-r--r--doc/man3/ASYNC_WAIT_CTX_new.pod8
-rw-r--r--doc/man3/ASYNC_start_job.pod2
-rw-r--r--doc/man3/BIO_new_CMS.pod2
-rw-r--r--doc/man3/BN_generate_prime.pod4
-rw-r--r--doc/man3/BN_rand.pod3
-rw-r--r--doc/man3/BN_security_bits.pod2
-rw-r--r--doc/man3/BUF_MEM_new.pod2
-rw-r--r--doc/man3/CTLOG_STORE_get0_log_by_id.pod2
-rw-r--r--doc/man3/DH_size.pod2
-rw-r--r--doc/man3/DTLS_get_data_mtu.pod2
-rw-r--r--doc/man3/DTLS_set_timer_cb.pod2
-rw-r--r--doc/man3/DTLSv1_listen.pod6
-rw-r--r--doc/man3/EC_GROUP_copy.pod2
-rw-r--r--doc/man3/EVP_DigestInit.pod8
-rw-r--r--doc/man3/EVP_DigestSignInit.pod2
-rw-r--r--doc/man3/EVP_DigestVerifyInit.pod2
-rw-r--r--doc/man3/EVP_EncryptInit.pod2
-rw-r--r--doc/man3/EVP_PKEY_CTX_ctrl.pod5
-rw-r--r--doc/man3/EVP_PKEY_CTX_new.pod2
-rw-r--r--doc/man3/EVP_PKEY_decrypt.pod2
-rw-r--r--doc/man3/EVP_PKEY_derive.pod2
-rw-r--r--doc/man3/EVP_PKEY_encrypt.pod2
-rw-r--r--doc/man3/EVP_PKEY_get_default_digest_nid.pod2
-rw-r--r--doc/man3/EVP_PKEY_keygen.pod2
-rw-r--r--doc/man3/EVP_PKEY_new.pod9
-rw-r--r--doc/man3/EVP_PKEY_print_private.pod2
-rw-r--r--doc/man3/EVP_PKEY_sign.pod2
-rw-r--r--doc/man3/EVP_PKEY_supports_digest_nid.pod2
-rw-r--r--doc/man3/EVP_PKEY_verify.pod2
-rw-r--r--doc/man3/EVP_PKEY_verify_recover.pod2
-rw-r--r--doc/man3/OPENSSL_secure_malloc.pod2
-rw-r--r--doc/man3/OSSL_STORE_INFO.pod2
-rw-r--r--doc/man3/OSSL_STORE_LOADER.pod2
-rw-r--r--doc/man3/OSSL_STORE_SEARCH.pod2
-rw-r--r--doc/man3/OSSL_STORE_expect.pod2
-rw-r--r--doc/man3/OSSL_STORE_open.pod2
-rw-r--r--doc/man3/OpenSSL_version.pod2
-rw-r--r--doc/man3/PEM_read_bio_ex.pod2
-rw-r--r--doc/man3/PEM_write_bio_CMS_stream.pod2
-rw-r--r--doc/man3/PEM_write_bio_PKCS7_stream.pod2
-rw-r--r--doc/man3/PKCS7_sign.pod4
-rw-r--r--doc/man3/PKCS7_sign_add_signer.pod2
-rw-r--r--doc/man3/RAND_bytes.pod2
-rw-r--r--doc/man3/RSA_get0_key.pod1
-rw-r--r--doc/man3/RSA_size.pod2
-rw-r--r--doc/man3/SRP_VBASE_new.pod4
-rw-r--r--doc/man3/SRP_create_verifier.pod2
-rw-r--r--doc/man3/SRP_user_pwd_new.pod2
-rw-r--r--doc/man3/SSL_CIPHER_get_name.pod14
-rw-r--r--doc/man3/SSL_COMP_add_compression_method.pod5
-rw-r--r--doc/man3/SSL_CONF_CTX_new.pod2
-rw-r--r--doc/man3/SSL_CONF_CTX_set1_prefix.pod2
-rw-r--r--doc/man3/SSL_CONF_CTX_set_flags.pod2
-rw-r--r--doc/man3/SSL_CONF_CTX_set_ssl_ctx.pod2
-rw-r--r--doc/man3/SSL_CONF_cmd.pod8
-rw-r--r--doc/man3/SSL_CONF_cmd_argv.pod2
-rw-r--r--doc/man3/SSL_CTX_add1_chain_cert.pod2
-rw-r--r--doc/man3/SSL_CTX_config.pod2
-rw-r--r--doc/man3/SSL_CTX_dane_enable.pod2
-rw-r--r--doc/man3/SSL_CTX_get0_param.pod2
-rw-r--r--doc/man3/SSL_CTX_set1_curves.pod4
-rw-r--r--doc/man3/SSL_CTX_set1_verify_cert_store.pod2
-rw-r--r--doc/man3/SSL_CTX_set_default_passwd_cb.pod2
-rw-r--r--doc/man3/SSL_CTX_set_mode.pod4
-rw-r--r--doc/man3/SSL_CTX_set_msg_callback.pod3
-rw-r--r--doc/man3/SSL_CTX_set_options.pod6
-rw-r--r--doc/man3/SSL_CTX_set_security_level.pod2
-rw-r--r--doc/man3/SSL_CTX_set_session_ticket_cb.pod4
-rw-r--r--doc/man3/SSL_CTX_set_split_send_fragment.pod4
-rw-r--r--doc/man3/SSL_CTX_set_srp_password.pod2
-rw-r--r--doc/man3/SSL_CTX_set_tlsext_status_cb.pod4
-rw-r--r--doc/man3/SSL_SESSION_free.pod2
-rw-r--r--doc/man3/SSL_SESSION_get0_cipher.pod4
-rw-r--r--doc/man3/SSL_SESSION_get0_hostname.pod4
-rw-r--r--doc/man3/SSL_SESSION_get0_id_context.pod2
-rw-r--r--doc/man3/SSL_SESSION_get_protocol_version.pod4
-rw-r--r--doc/man3/SSL_SESSION_has_ticket.pod4
-rw-r--r--doc/man3/SSL_SESSION_is_resumable.pod2
-rw-r--r--doc/man3/SSL_SESSION_set1_id.pod2
-rw-r--r--doc/man3/SSL_export_keying_material.pod2
-rw-r--r--doc/man3/SSL_extension_supported.pod2
-rw-r--r--doc/man3/SSL_get_all_async_fds.pod4
-rw-r--r--doc/man3/SSL_get_error.pod4
-rw-r--r--doc/man3/SSL_get_version.pod2
-rw-r--r--doc/man3/SSL_read.pod2
-rw-r--r--doc/man3/SSL_set1_host.pod2
-rw-r--r--doc/man3/SSL_want.pod3
-rw-r--r--doc/man3/SSL_write.pod2
-rw-r--r--doc/man3/UI_create_method.pod5
-rw-r--r--doc/man3/UI_new.pod5
-rw-r--r--doc/man3/X509_STORE_CTX_new.pod4
-rw-r--r--doc/man3/X509_STORE_CTX_set_verify_cb.pod3
-rw-r--r--doc/man3/X509_STORE_new.pod2
-rw-r--r--doc/man3/X509_STORE_set_verify_cb_func.pod7
-rw-r--r--doc/man3/X509_VERIFY_PARAM_set_flags.pod8
-rw-r--r--doc/man3/X509_get0_signature.pod10
-rw-r--r--doc/man3/X509_get_serialNumber.pod5
-rw-r--r--doc/man3/X509_get_subject_name.pod4
-rw-r--r--doc/man3/X509_sign.pod8
-rw-r--r--doc/man3/i2d_CMS_bio_stream.pod2
-rw-r--r--doc/man3/i2d_PKCS7_bio_stream.pod2
102 files changed, 166 insertions, 158 deletions
diff --git a/doc/man3/ASN1_INTEGER_get_int64.pod b/doc/man3/ASN1_INTEGER_get_int64.pod
index 7cc7584c4d..da1e432a2c 100644
--- a/doc/man3/ASN1_INTEGER_get_int64.pod
+++ b/doc/man3/ASN1_INTEGER_get_int64.pod
@@ -119,7 +119,7 @@ L<ERR_get_error(3)>
ASN1_INTEGER_set_int64(), ASN1_INTEGER_get_int64(),
ASN1_ENUMERATED_set_int64() and ASN1_ENUMERATED_get_int64()
-were added to OpenSSL 1.1.0.
+were added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/ASYNC_WAIT_CTX_new.pod b/doc/man3/ASYNC_WAIT_CTX_new.pod
index 54790133d6..eeb2777a8b 100644
--- a/doc/man3/ASYNC_WAIT_CTX_new.pod
+++ b/doc/man3/ASYNC_WAIT_CTX_new.pod
@@ -127,10 +127,10 @@ L<crypto(7)>, L<ASYNC_start_job(3)>
=head1 HISTORY
-ASYNC_WAIT_CTX_new, ASYNC_WAIT_CTX_free, ASYNC_WAIT_CTX_set_wait_fd,
-ASYNC_WAIT_CTX_get_fd, ASYNC_WAIT_CTX_get_all_fds,
-ASYNC_WAIT_CTX_get_changed_fds, ASYNC_WAIT_CTX_clear_fd were first added to
-OpenSSL 1.1.0.
+ASYNC_WAIT_CTX_new(), ASYNC_WAIT_CTX_free(), ASYNC_WAIT_CTX_set_wait_fd(),
+ASYNC_WAIT_CTX_get_fd(), ASYNC_WAIT_CTX_get_all_fds(),
+ASYNC_WAIT_CTX_get_changed_fds() and ASYNC_WAIT_CTX_clear_fd()
+were added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/ASYNC_start_job.pod b/doc/man3/ASYNC_start_job.pod
index 723d53417f..95694b636a 100644
--- a/doc/man3/ASYNC_start_job.pod
+++ b/doc/man3/ASYNC_start_job.pod
@@ -317,7 +317,7 @@ L<crypto(7)>, L<ERR_print_errors(3)>
ASYNC_init_thread, ASYNC_cleanup_thread,
ASYNC_start_job, ASYNC_pause_job, ASYNC_get_current_job, ASYNC_get_wait_ctx(),
ASYNC_block_pause(), ASYNC_unblock_pause() and ASYNC_is_capable() were first
-added to OpenSSL 1.1.0.
+added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/BIO_new_CMS.pod b/doc/man3/BIO_new_CMS.pod
index 841cb17ff4..4872b56ee4 100644
--- a/doc/man3/BIO_new_CMS.pod
+++ b/doc/man3/BIO_new_CMS.pod
@@ -61,7 +61,7 @@ L<CMS_encrypt(3)>
=head1 HISTORY
-BIO_new_CMS() was added to OpenSSL 1.0.0
+The BIO_new_CMS() function was added in OpenSSL 1.0.0.
=head1 COPYRIGHT
diff --git a/doc/man3/BN_generate_prime.pod b/doc/man3/BN_generate_prime.pod
index 7784b80ebc..253fde3c70 100644
--- a/doc/man3/BN_generate_prime.pod
+++ b/doc/man3/BN_generate_prime.pod
@@ -197,8 +197,8 @@ L<RSA_generate_key(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>
=head1 HISTORY
-BN_GENCB_new(), BN_GENCB_free(),
-and BN_GENCB_get_arg() were added in OpenSSL 1.1.0
+The BN_GENCB_new(), BN_GENCB_free(),
+and BN_GENCB_get_arg() functions were added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/BN_rand.pod b/doc/man3/BN_rand.pod
index 18f7090836..3ceeff1d31 100644
--- a/doc/man3/BN_rand.pod
+++ b/doc/man3/BN_rand.pod
@@ -73,7 +73,8 @@ a future release.
=item *
-BN_priv_rand() and BN_priv_rand_range() were added in OpenSSL 1.1.1.
+The
+BN_priv_rand() and BN_priv_rand_range() functions were added in OpenSSL 1.1.1.
=back
diff --git a/doc/man3/BN_security_bits.pod b/doc/man3/BN_security_bits.pod
index 9762be9305..3b9bf88724 100644
--- a/doc/man3/BN_security_bits.pod
+++ b/doc/man3/BN_security_bits.pod
@@ -33,7 +33,7 @@ function. The symmetric algorithms are not covered neither.
=head1 HISTORY
-BN_security_bits() was added in OpenSSL 1.1.0.
+The BN_security_bits() function was added in OpenSSL 1.1.0.
=head1 SEE ALSO
diff --git a/doc/man3/BUF_MEM_new.pod b/doc/man3/BUF_MEM_new.pod
index dfca6fe0ce..262e18f31b 100644
--- a/doc/man3/BUF_MEM_new.pod
+++ b/doc/man3/BUF_MEM_new.pod
@@ -61,7 +61,7 @@ L<CRYPTO_secure_malloc(3)>.
=head1 HISTORY
-BUF_MEM_new_ex() was added in OpenSSL 1.1.0.
+The BUF_MEM_new_ex() function was added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/CTLOG_STORE_get0_log_by_id.pod b/doc/man3/CTLOG_STORE_get0_log_by_id.pod
index 3f4f1b9f30..813b9d9788 100644
--- a/doc/man3/CTLOG_STORE_get0_log_by_id.pod
+++ b/doc/man3/CTLOG_STORE_get0_log_by_id.pod
@@ -35,7 +35,7 @@ L<CTLOG_STORE_new(3)>
=head1 HISTORY
-This function was added in OpenSSL 1.1.0.
+The CTLOG_STORE_get0_log_by_id() function was added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/DH_size.pod b/doc/man3/DH_size.pod
index 3899a842f5..3161ef3ee3 100644
--- a/doc/man3/DH_size.pod
+++ b/doc/man3/DH_size.pod
@@ -43,7 +43,7 @@ L<BN_num_bits(3)>
=head1 HISTORY
-DH_bits() was added in OpenSSL 1.1.0.
+The DH_bits() function was added in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/DTLS_get_data_mtu.pod b/doc/man3/DTLS_get_data_mtu.pod
index c73ee1737c..ee74fa1704 100644
--- a/doc/man3/DTLS_get_data_mtu.pod
+++ b/doc/man3/DTLS_get_data_mtu.pod
@@ -22,7 +22,7 @@ Returns the maximum data payload size on success, or 0 on failure.
=head1 HISTORY
-This function was added in OpenSSL 1.1.1
+The DTLS_get_data_mtu() function was added in OpenSSL 1.1.1.
=head1 COPYRIGHT
diff --git a/doc/man3/DTLS_set_timer_cb.pod b/doc/man3/DTLS_set_timer_cb.pod
index 78907b903b..5014e77d0f 100644
--- a/doc/man3/DTLS_set_timer_cb.pod
+++ b/doc/man3/DTLS_set_timer_cb.pod
@@ -26,7 +26,7 @@ Returns void.
=head1 HISTORY
-This function was added in OpenSSL 1.1.1
+The DTLS_set_timer_cb() function was added in OpenSSL 1.1.1.
=head1 COPYRIGHT
diff --git a/doc/man3/DTLSv1_listen.pod b/doc/man3/DTLSv1_listen.pod
index 60d73ae769..be4d53143c 100644
--- a/doc/man3/DTLSv1_listen.pod
+++ b/doc/man3/DTLSv1_listen.pod
@@ -117,10 +117,10 @@ L<ssl(7)>, L<bio(7)>
=head1 HISTORY
-SSL_stateless() was first added in OpenSSL 1.1.1.
+The SSL_stateless() function was added in OpenSSL 1.1.1.
-DTLSv1_listen() return codes were clarified in OpenSSL 1.1.0. The type of "peer"
-also changed in OpenSSL 1.1.0.
+The DTLSv1_listen() return codes were clarified in OpenSSL 1.1.0.
+The type of "peer" also changed in OpenSSL 1.1.0.
=head1 COPYRIGHT
diff --git a/doc/man3/EC_GROUP_copy.pod b/doc/man3/EC_GROUP_copy.pod
index b656b98e4c..453825a760 100644
--- a/doc/man3/EC_GROUP_copy.pod
+++ b/doc/man3/EC_GROUP_copy.pod
@@ -89,7 +89,7 @@ named curve form is used and the parameters must have a corresponding
named curve NID set. If asn1_flags is B<OPENSSL_EC_EXPLICIT_CURVE> the
parameters are explicitly encoded. The functions EC_GROUP_get_asn1_flag and
EC_GROUP_set_asn1_flag get and set the status of the asn1_flag for the curve.
-Note: B<OPENSSL_EC_EXPLICIT_CURVE> was first added to OpenSSL 1.1.0, for
+Note: B<OPENSSL_EC_EXPLICIT_CURVE> was added in OpenSSL 1.1.0, for
previous versions of OpenSSL the value 0 must be used instead. Before OpenSSL
1.1.0 the default form was to use explicit parameters (meaning that
applications would have to explicitly set the named curve form) in OpenSSL
diff --git a/doc/man3/EVP_DigestInit.pod b/doc/man3/EVP_DigestInit.pod
index ccb59cffb1..f7ecda5c91 100644
--- a/doc/man3/EVP_DigestInit.pod
+++ b/doc/man3/EVP_DigestInit.pod
@@ -369,15 +369,15 @@ L<EVP_whirlpool(3)>
=head1 HISTORY
-EVP_MD_CTX_create() and EVP_MD_CTX_destroy() were renamed to
-EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.0.
+The EVP_MD_CTX_create() and EVP_MD_CTX_destroy() functions were renamed to
+EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.0, respectively.