From 35d2e3275f9b313ed63754641118ecbbc7873413 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Fri, 3 Jun 2016 16:19:49 -0400 Subject: [PATCH] Remove extra include's in synopsis. Reviewed-by: Richard Levitte --- doc/crypto/BIO_f_base64.pod | 4 +++- doc/crypto/BIO_f_cipher.pod | 4 +++- doc/crypto/BIO_f_md.pod | 10 ++++++---- doc/crypto/BIO_f_ssl.pod | 2 ++ doc/crypto/DH_set_method.pod | 1 - doc/crypto/DSA_set_method.pod | 1 - doc/crypto/EC_GROUP_copy.pod | 1 - doc/crypto/EC_GROUP_new.pod | 1 - doc/crypto/EC_KEY_new.pod | 1 - doc/crypto/EC_POINT_add.pod | 1 - doc/crypto/EC_POINT_new.pod | 1 - doc/crypto/PEM_write_bio_CMS_stream.pod | 1 - doc/crypto/PEM_write_bio_PKCS7_stream.pod | 1 - doc/crypto/X509_STORE_CTX_get_error.pod | 1 - doc/crypto/d2i_DSAPublicKey.pod | 1 - doc/crypto/d2i_RSAPublicKey.pod | 1 - doc/crypto/dh.pod | 21 ++++++++++----------- doc/crypto/dsa.pod | 1 - doc/crypto/ec.pod | 1 - doc/crypto/rsa.pod | 1 - doc/ssl/SSL_set1_host.pod | 1 - 21 files changed, 24 insertions(+), 33 deletions(-) diff --git a/doc/crypto/BIO_f_base64.pod b/doc/crypto/BIO_f_base64.pod index 6c78f7e546..19df1dd638 100644 --- a/doc/crypto/BIO_f_base64.pod +++ b/doc/crypto/BIO_f_base64.pod @@ -4,12 +4,14 @@ BIO_f_base64 - base64 BIO filter +=for comment multiple includes + =head1 SYNOPSIS #include #include - const BIO_METHOD * BIO_f_base64(void); + const BIO_METHOD *BIO_f_base64(void); =head1 DESCRIPTION diff --git a/doc/crypto/BIO_f_cipher.pod b/doc/crypto/BIO_f_cipher.pod index 8b8e2001d1..87ab3ccc9d 100644 --- a/doc/crypto/BIO_f_cipher.pod +++ b/doc/crypto/BIO_f_cipher.pod @@ -4,13 +4,15 @@ BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx - cipher BIO filter +=for comment multiple includes + =head1 SYNOPSIS #include #include const BIO_METHOD *BIO_f_cipher(void); - void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher, + void BIO_set_cipher(BIO *b, const EVP_CIPHER *cipher, unsigned char *key, unsigned char *iv, int enc); int BIO_get_cipher_status(BIO *b) int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx) diff --git a/doc/crypto/BIO_f_md.pod b/doc/crypto/BIO_f_md.pod index 001f3506fa..b2c1433d25 100644 --- a/doc/crypto/BIO_f_md.pod +++ b/doc/crypto/BIO_f_md.pod @@ -4,15 +4,17 @@ BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx - message digest BIO filter +=for comment multiple includes + =head1 SYNOPSIS #include #include - const BIO_METHOD * BIO_f_md(void); - int BIO_set_md(BIO *b,EVP_MD *md); - int BIO_get_md(BIO *b,EVP_MD **mdp); - int BIO_get_md_ctx(BIO *b,EVP_MD_CTX **mdcp); + const BIO_METHOD *BIO_f_md(void); + int BIO_set_md(BIO *b, EVP_MD *md); + int BIO_get_md(BIO *b, EVP_MD **mdp); + int BIO_get_md_ctx(BIO *b, EVP_MD_CTX **mdcp); =head1 DESCRIPTION diff --git a/doc/crypto/BIO_f_ssl.pod b/doc/crypto/BIO_f_ssl.pod index 9ebd4d1e68..4c9da6a2ca 100644 --- a/doc/crypto/BIO_f_ssl.pod +++ b/doc/crypto/BIO_f_ssl.pod @@ -7,6 +7,8 @@ BIO_get_num_renegotiates, BIO_set_ssl_renegotiate_timeout, BIO_new_ssl, BIO_new_ssl_connect, BIO_new_buffer_ssl_connect, BIO_ssl_copy_session_id, BIO_ssl_shutdown - SSL BIO +=for comment multiple includes + =head1 SYNOPSIS #include diff --git a/doc/crypto/DH_set_method.pod b/doc/crypto/DH_set_method.pod index b10d91f1e7..cd75a9b549 100644 --- a/doc/crypto/DH_set_method.pod +++ b/doc/crypto/DH_set_method.pod @@ -8,7 +8,6 @@ DH_set_method, DH_new_method, DH_OpenSSL - select DH method =head1 SYNOPSIS #include - #include void DH_set_default_method(const DH_METHOD *meth); diff --git a/doc/crypto/DSA_set_method.pod b/doc/crypto/DSA_set_method.pod index 7d1fe629b4..a64725f7e4 100644 --- a/doc/crypto/DSA_set_method.pod +++ b/doc/crypto/DSA_set_method.pod @@ -8,7 +8,6 @@ DSA_set_method, DSA_new_method, DSA_OpenSSL - select DSA method =head1 SYNOPSIS #include - #include void DSA_set_default_method(const DSA_METHOD *meth); diff --git a/doc/crypto/EC_GROUP_copy.pod b/doc/crypto/EC_GROUP_copy.pod index 69909bd01e..f295f86c6a 100644 --- a/doc/crypto/EC_GROUP_copy.pod +++ b/doc/crypto/EC_GROUP_copy.pod @@ -7,7 +7,6 @@ EC_GROUP_copy, EC_GROUP_dup, EC_GROUP_method_of, EC_GROUP_set_generator, EC_GROU =head1 SYNOPSIS #include - #include int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src); EC_GROUP *EC_GROUP_dup(const EC_GROUP *src); diff --git a/doc/crypto/EC_GROUP_new.pod b/doc/crypto/EC_GROUP_new.pod index 822ff83f47..14c51d452b 100644 --- a/doc/crypto/EC_GROUP_new.pod +++ b/doc/crypto/EC_GROUP_new.pod @@ -13,7 +13,6 @@ objects. =head1 SYNOPSIS #include - #include EC_GROUP *EC_GROUP_new(const EC_METHOD *meth); EC_GROUP *EC_GROUP_new_from_ecparameters(const ECPARAMETERS *params) diff --git a/doc/crypto/EC_KEY_new.pod b/doc/crypto/EC_KEY_new.pod index 5b3fe0504d..edcf744f7b 100644 --- a/doc/crypto/EC_KEY_new.pod +++ b/doc/crypto/EC_KEY_new.pod @@ -16,7 +16,6 @@ EC_KEY objects. =head1 SYNOPSIS #include - #include EC_KEY *EC_KEY_new(void); int EC_KEY_get_flags(const EC_KEY *key); diff --git a/doc/crypto/EC_POINT_add.pod b/doc/crypto/EC_POINT_add.pod index 5b44cbd700..153aa1be6e 100644 --- a/doc/crypto/EC_POINT_add.pod +++ b/doc/crypto/EC_POINT_add.pod @@ -7,7 +7,6 @@ EC_POINT_add, EC_POINT_dbl, EC_POINT_invert, EC_POINT_is_at_infinity, EC_POINT_i =head1 SYNOPSIS #include - #include int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx); int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx); diff --git a/doc/crypto/EC_POINT_new.pod b/doc/crypto/EC_POINT_new.pod index 89b0c0ab1e..d58bfbab2b 100644 --- a/doc/crypto/EC_POINT_new.pod +++ b/doc/crypto/EC_POINT_new.pod @@ -15,7 +15,6 @@ manipulating B objects. =head1 SYNOPSIS #include - #include EC_POINT *EC_POINT_new(const EC_GROUP *group); void EC_POINT_free(EC_POINT *point); diff --git a/doc/crypto/PEM_write_bio_CMS_stream.pod b/doc/crypto/PEM_write_bio_CMS_stream.pod index f6b0fed7c6..c43be11558 100644 --- a/doc/crypto/PEM_write_bio_CMS_stream.pod +++ b/doc/crypto/PEM_write_bio_CMS_stream.pod @@ -7,7 +7,6 @@ PEM_write_bio_CMS_stream - output CMS_ContentInfo structure in PEM format. =head1 SYNOPSIS #include - #include int PEM_write_bio_CMS_stream(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags); diff --git a/doc/crypto/PEM_write_bio_PKCS7_stream.pod b/doc/crypto/PEM_write_bio_PKCS7_stream.pod index 175d7244bf..b8372b4cba 100644 --- a/doc/crypto/PEM_write_bio_PKCS7_stream.pod +++ b/doc/crypto/PEM_write_bio_PKCS7_stream.pod @@ -7,7 +7,6 @@ PEM_write_bio_PKCS7_stream - output PKCS7 structure in PEM format. =head1 SYNOPSIS #include - #include int PEM_write_bio_PKCS7_stream(BIO *out, PKCS7 *p7, BIO *data, int flags); diff --git a/doc/crypto/X509_STORE_CTX_get_error.pod b/doc/crypto/X509_STORE_CTX_get_error.pod index 428e500ff2..26fcf607c3 100644 --- a/doc/crypto/X509_STORE_CTX_get_error.pod +++ b/doc/crypto/X509_STORE_CTX_get_error.pod @@ -12,7 +12,6 @@ information =head1 SYNOPSIS #include - #include int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx); void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx, int s); diff --git a/doc/crypto/d2i_DSAPublicKey.pod b/doc/crypto/d2i_DSAPublicKey.pod index d38f131394..252d0a52a6 100644 --- a/doc/crypto/d2i_DSAPublicKey.pod +++ b/doc/crypto/d2i_DSAPublicKey.pod @@ -9,7 +9,6 @@ d2i_DSA_SIG, i2d_DSA_SIG - DSA key encoding and parsing functions. =head1 SYNOPSIS #include - #include DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); diff --git a/doc/crypto/d2i_RSAPublicKey.pod b/doc/crypto/d2i_RSAPublicKey.pod index 8b6e12d0f7..fcfce67c76 100644 --- a/doc/crypto/d2i_RSAPublicKey.pod +++ b/doc/crypto/d2i_RSAPublicKey.pod @@ -10,7 +10,6 @@ d2i_Netscape_RSA - RSA public and private key encoding functions. =head1 SYNOPSIS #include - #include RSA * d2i_RSAPublicKey(RSA **a, const unsigned char **pp, long length); diff --git a/doc/crypto/dh.pod b/doc/crypto/dh.pod index b56c27ca51..95b5fab81e 100644 --- a/doc/crypto/dh.pod +++ b/doc/crypto/dh.pod @@ -7,17 +7,16 @@ dh - Diffie-Hellman key agreement =head1 SYNOPSIS #include - #include - DH * DH_new(void); - void DH_free(DH *dh); + DH *DH_new(void); + void DH_free(DH *dh); - DH * DH_generate_parameters(int prime_len, int generator, + DH *DH_generate_parameters(int prime_len, int generator, void (*callback)(int, int, void *), void *cb_arg); - int DH_check(const DH *dh, int *codes); + int DH_check(const DH *dh, int *codes); - int DH_generate_key(DH *dh); - int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh); + int DH_generate_key(DH *dh); + int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh); void DH_set_default_method(const DH_METHOD *meth); const DH_METHOD *DH_get_default_method(void); @@ -25,11 +24,11 @@ dh - Diffie-Hellman key agreement DH *DH_new_method(ENGINE *engine); const DH_METHOD *DH_OpenSSL(void); - DH * d2i_DHparams(DH **a, unsigned char **pp, long length); - int i2d_DHparams(const DH *a, unsigned char **pp); + DH *d2i_DHparams(DH **a, unsigned char **pp, long length); + int i2d_DHparams(const DH *a, unsigned char **pp); - int DHparams_print_fp(FILE *fp, const DH *x); - int DHparams_print(BIO *bp, const DH *x); + int DHparams_print_fp(FILE *fp, const DH *x); + int DHparams_print(BIO *bp, const DH *x); =head1 DESCRIPTION diff --git a/doc/crypto/dsa.pod b/doc/crypto/dsa.pod index 2850c1d1a9..c803caf1c7 100644 --- a/doc/crypto/dsa.pod +++ b/doc/crypto/dsa.pod @@ -7,7 +7,6 @@ dsa - Digital Signature Algorithm =head1 SYNOPSIS #include - #include DSA * DSA_new(void); void DSA_free(DSA *dsa); diff --git a/doc/crypto/ec.pod b/doc/crypto/ec.pod index 5e20b4ee1f..cb073d7d84 100644 --- a/doc/crypto/ec.pod +++ b/doc/crypto/ec.pod @@ -7,7 +7,6 @@ ec - Elliptic Curve functions =head1 SYNOPSIS #include - #include const EC_METHOD *EC_GFp_simple_method(void); const EC_METHOD *EC_GFp_mont_method(void); diff --git a/doc/crypto/rsa.pod b/doc/crypto/rsa.pod index 2a2a1e898d..4f7de72d2c 100644 --- a/doc/crypto/rsa.pod +++ b/doc/crypto/rsa.pod @@ -7,7 +7,6 @@ rsa - RSA public key cryptosystem =head1 SYNOPSIS #include - #include RSA * RSA_new(void); void RSA_free(RSA *rsa); diff --git a/doc/ssl/SSL_set1_host.pod b/doc/ssl/SSL_set1_host.pod index b77d41f336..3339a0e803 100644 --- a/doc/ssl/SSL_set1_host.pod +++ b/doc/ssl/SSL_set1_host.pod @@ -8,7 +8,6 @@ SSL server verification parameters =head1 SYNOPSIS #include - #include int SSL_set1_host(SSL *s, const char *hostname); int SSL_add1_host(SSL *s, const char *hostname); -- GitLab