summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBeat Bolli <dev@drbeat.li>2017-01-20 19:58:49 +0100
committerMatt Caswell <matt@openssl.org>2017-06-08 11:54:16 +0100
commite9b77246879071308130cda42336338ddb63cbb4 (patch)
treefc69eee78ddd45bc873d1d6ee103139bdaf27674
parent61ced34f8d7a7f1dedaa5a5b3554c4dcdec610df (diff)
doc/man3: reformat the function prototypes in the synopses
I tried hard to keep the lines at 80 characters or less, but in a few cases I had to punt and just indented the subsequent lines by 4 spaces. A few well-placed typedefs for callback functions would really help, but these would be part of the API, so that's probably for later. I also took the liberty of inserting empty lines in overlong blocks to provide some visual space. Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1956)
-rw-r--r--doc/man3/ASN1_TIME_set.pod3
-rw-r--r--doc/man3/ASYNC_WAIT_CTX_new.pod2
-rw-r--r--doc/man3/ASYNC_start_job.pod1
-rw-r--r--doc/man3/BF_encrypt.pod12
-rw-r--r--doc/man3/BIO_ctrl.pod3
-rw-r--r--doc/man3/BIO_f_cipher.pod2
-rw-r--r--doc/man3/BIO_f_md.pod4
-rw-r--r--doc/man3/BIO_f_null.pod2
-rw-r--r--doc/man3/BIO_find_type.pod2
-rw-r--r--doc/man3/BIO_get_ex_new_index.pod6
-rw-r--r--doc/man3/BIO_meth_new.pod58
-rw-r--r--doc/man3/BIO_new.pod12
-rw-r--r--doc/man3/BIO_s_bio.pod2
-rw-r--r--doc/man3/BIO_s_file.pod6
-rw-r--r--doc/man3/BIO_s_mem.pod9
-rw-r--r--doc/man3/BIO_s_null.pod2
-rw-r--r--doc/man3/BN_BLINDING_new.pod18
-rw-r--r--doc/man3/BN_add.pod10
-rw-r--r--doc/man3/BN_generate_prime.pod19
-rw-r--r--doc/man3/BN_mod_inverse.pod2
-rw-r--r--doc/man3/BN_mod_mul_montgomery.pod6
-rw-r--r--doc/man3/BN_mod_mul_reciprocal.pod4
-rw-r--r--doc/man3/CMS_add0_cert.pod1
-rw-r--r--doc/man3/CMS_add1_recipient_cert.pod12
-rw-r--r--doc/man3/CMS_add1_signer.pod5
-rw-r--r--doc/man3/CMS_decrypt.pod3
-rw-r--r--doc/man3/CMS_encrypt.pod3
-rw-r--r--doc/man3/CMS_get0_RecipientInfos.pod17
-rw-r--r--doc/man3/CMS_get0_SignerInfos.pod3
-rw-r--r--doc/man3/CMS_get1_ReceiptRequest.pod10
-rw-r--r--doc/man3/CMS_sign.pod3
-rw-r--r--doc/man3/CMS_sign_receipt.pod4
-rw-r--r--doc/man3/CMS_verify.pod3
-rw-r--r--doc/man3/CMS_verify_receipt.pod4
-rw-r--r--doc/man3/CONF_modules_load_file.pod5
-rw-r--r--doc/man3/CRYPTO_get_ex_new_index.pod8
-rw-r--r--doc/man3/CT_POLICY_EVAL_CTX_new.pod3
-rw-r--r--doc/man3/DEFINE_STACK_OF.pod3
-rw-r--r--doc/man3/DES_random_key.pod93
-rw-r--r--doc/man3/DH_generate_parameters.pod2
-rw-r--r--doc/man3/DH_meth_new.pod33
-rw-r--r--doc/man3/DSA_do_sign.pod2
-rw-r--r--doc/man3/DSA_dup_DH.pod2
-rw-r--r--doc/man3/DSA_generate_parameters.pod11
-rw-r--r--doc/man3/DSA_meth_new.pod88
-rw-r--r--doc/man3/DSA_sign.pod9
-rw-r--r--doc/man3/ECDSA_SIG_new.pod2
-rw-r--r--doc/man3/EC_GROUP_copy.pod5
-rw-r--r--doc/man3/EC_GROUP_new.pod18
-rw-r--r--doc/man3/EC_KEY_new.pod6
-rw-r--r--doc/man3/EC_POINT_add.pod12
-rw-r--r--doc/man3/ENGINE_add.pod10
-rw-r--r--doc/man3/ERR_get_error.pod6
-rw-r--r--doc/man3/ERR_print_errors.pod3
-rw-r--r--doc/man3/ERR_put_error.pod3
-rw-r--r--doc/man3/EVP_CIPHER_meth_new.pod32
-rw-r--r--doc/man3/EVP_DigestInit.pod6
-rw-r--r--doc/man3/EVP_DigestVerifyInit.pod2
-rw-r--r--doc/man3/EVP_EncodeInit.pod3
-rw-r--r--doc/man3/EVP_EncryptInit.pod36
-rw-r--r--doc/man3/EVP_OpenInit.pod7
-rw-r--r--doc/man3/EVP_PKEY_CTX_ctrl.pod4
-rw-r--r--doc/man3/EVP_PKEY_CTX_set_tls1_prf_md.pod1
-rw-r--r--doc/man3/EVP_PKEY_decrypt.pod5
-rw-r--r--doc/man3/EVP_PKEY_encrypt.pod5
-rw-r--r--doc/man3/EVP_PKEY_keygen.pod3
-rw-r--r--doc/man3/EVP_PKEY_print_private.pod6
-rw-r--r--doc/man3/EVP_PKEY_sign.pod4
-rw-r--r--doc/man3/EVP_PKEY_verify.pod5
-rw-r--r--doc/man3/EVP_PKEY_verify_recover.pod5
-rw-r--r--doc/man3/EVP_SealInit.pod5
-rw-r--r--doc/man3/EVP_VerifyInit.pod3
-rw-r--r--doc/man3/HMAC.pod6
-rw-r--r--doc/man3/MD5.pod18
-rw-r--r--doc/man3/MDC2_Init.pod4
-rw-r--r--doc/man3/OBJ_nid2obj.pod11
-rw-r--r--doc/man3/OPENSSL_malloc.pod3
-rw-r--r--doc/man3/PEM_read_bio_PrivateKey.pod3
-rw-r--r--doc/man3/PKCS12_newpass.pod1
-rw-r--r--doc/man3/PKCS5_PBKDF2_HMAC.pod6
-rw-r--r--doc/man3/PKCS7_encrypt.pod3
-rw-r--r--doc/man3/PKCS7_sign.pod4
-rw-r--r--doc/man3/PKCS7_sign_add_signer.pod3
-rw-r--r--doc/man3/PKCS7_verify.pod3
-rw-r--r--doc/man3/RIPEMD160_Init.pod5
-rw-r--r--doc/man3/RSA_generate_key.pod2
-rw-r--r--doc/man3/RSA_meth_new.pod133
-rw-r--r--doc/man3/RSA_new.pod2
-rw-r--r--doc/man3/RSA_padding_add_PKCS1_type_1.pod21
-rw-r--r--doc/man3/RSA_private_encrypt.pod8
-rw-r--r--doc/man3/RSA_public_encrypt.pod8
-rw-r--r--doc/man3/RSA_sign.pod4
-rw-r--r--doc/man3/RSA_sign_ASN1_OCTET_STRING.pod8
-rw-r--r--doc/man3/SHA256_Init.pod10
-rw-r--r--doc/man3/SSL_CTX_sess_set_get_cb.pod24
-rw-r--r--doc/man3/SSL_CTX_set_cert_cb.pod3
-rw-r--r--doc/man3/SSL_CTX_set_cert_verify_callback.pod4
-rw-r--r--doc/man3/SSL_CTX_set_client_cert_cb.pod7
-rw-r--r--doc/man3/SSL_CTX_set_generate_session_id.pod1
-rw-r--r--doc/man3/SSL_CTX_set_min_proto_version.pod1
-rw-r--r--doc/man3/SSL_CTX_set_msg_callback.pod10
-rw-r--r--doc/man3/SSL_CTX_set_psk_client_callback.pod12
-rw-r--r--doc/man3/SSL_CTX_set_security_level.pod23
-rw-r--r--doc/man3/SSL_CTX_set_tlsext_status_cb.pod6
-rw-r--r--doc/man3/SSL_CTX_set_tlsext_ticket_key_cb.pod6
-rw-r--r--doc/man3/SSL_CTX_set_tmp_dh_callback.pod11
-rw-r--r--doc/man3/SSL_CTX_use_psk_identity_hint.pod12
-rw-r--r--doc/man3/SSL_get_client_random.pod3
-rw-r--r--doc/man3/SSL_get_psk_identity.pod1
-rw-r--r--doc/man3/UI_new.pod18
-rw-r--r--doc/man3/X509_LOOKUP_hash_dir.pod12
-rw-r--r--doc/man3/X509_NAME_ENTRY_get_object.pod21
-rw-r--r--doc/man3/X509_NAME_add_entry_by_txt.pod10
-rw-r--r--doc/man3/X509_NAME_print_ex.pod2
-rw-r--r--doc/man3/X509_STORE_CTX_set_verify_cb.pod1
-rw-r--r--doc/man3/X509_VERIFY_PARAM_set_flags.pod9
-rw-r--r--doc/man3/X509_check_ca.pod4
-rw-r--r--doc/man3/X509_digest.pod2
-rw-r--r--doc/man3/X509_get_extension_flags.pod20
-rw-r--r--doc/man3/X509v3_get_ext_by_NID.pod2
-rw-r--r--doc/man3/d2i_PKCS8PrivateKey_bio.pod16
-rw-r--r--doc/man3/d2i_SSL_SESSION.pod3
-rw-r--r--doc/man3/o2i_SCT_LIST.pod3
123 files changed, 681 insertions, 541 deletions
diff --git a/doc/man3/ASN1_TIME_set.pod b/doc/man3/ASN1_TIME_set.pod
index b6acd730b7..e1a5234727 100644
--- a/doc/man3/ASN1_TIME_set.pod
+++ b/doc/man3/ASN1_TIME_set.pod
@@ -85,9 +85,11 @@ Set a time structure to one hour after the current time and print it out:
#include <time.h>
#include <openssl/asn1.h>
+
ASN1_TIME *tm;
time_t t;
BIO *b;
+
t = time(NULL);
tm = ASN1_TIME_adj(NULL, t, 0, 60 * 60);
b = BIO_new_fp(stdout, BIO_NOCLOSE);
@@ -101,7 +103,6 @@ Determine if one time is later or sooner than the current time:
if (!ASN1_TIME_diff(&day, &sec, NULL, to))
/* Invalid time format */
-
if (day > 0 || sec > 0)
printf("Later\n");
else if (day < 0 || sec < 0)
diff --git a/doc/man3/ASYNC_WAIT_CTX_new.pod b/doc/man3/ASYNC_WAIT_CTX_new.pod
index 017e328b5e..204280210e 100644
--- a/doc/man3/ASYNC_WAIT_CTX_new.pod
+++ b/doc/man3/ASYNC_WAIT_CTX_new.pod
@@ -17,7 +17,7 @@ waiting for asynchronous jobs to complete
OSSL_ASYNC_FD fd,
void *custom_data,
void (*cleanup)(ASYNC_WAIT_CTX *, const void *,
- OSSL_ASYNC_FD, void *));
+ OSSL_ASYNC_FD, void *));
int ASYNC_WAIT_CTX_get_fd(ASYNC_WAIT_CTX *ctx, const void *key,
OSSL_ASYNC_FD *fd, void **custom_data);
int ASYNC_WAIT_CTX_get_all_fds(ASYNC_WAIT_CTX *ctx, OSSL_ASYNC_FD *fd,
diff --git a/doc/man3/ASYNC_start_job.pod b/doc/man3/ASYNC_start_job.pod
index e6ccf55c4d..21b77a96b9 100644
--- a/doc/man3/ASYNC_start_job.pod
+++ b/doc/man3/ASYNC_start_job.pod
@@ -187,6 +187,7 @@ The following example demonstrates how to use most of the cor