Add comments to NULL func ptrs in bio_method_st

This commit adds comments to bio_method_st definitions where the
function pointers are defined as NULL. Most of the structs have comments
but some where missing and not all consitent.

CLA: trivial

Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4881)

(cherry picked from commit b4ff66223b53ad9d2f5b4efd75bf8d52cc59c8dd)

diff --git a/crypto/bio/bss_acpt.c b/crypto/bio/bss_acpt.c
index 6fb971a50d513ecfd7120e5317a5f724868d7b7b..f0fe7f0a8ef53c46f498ce1df7f3cf628cc7ee52 100644 (file)
--- a/crypto/bio/bss_acpt.c
+++ b/crypto/bio/bss_acpt.c
@@ -57,11 +57,11 @@ static const BIO_METHOD methods_acceptp = {
     acpt_write,
     acpt_read,
     acpt_puts,
-    NULL,                       /* connect_gets, */
+    NULL,                       /* connect_gets,         */
     acpt_ctrl,
     acpt_new,
     acpt_free,
-    NULL,
+    NULL,                       /* connect_callback_ctrl */
 };
 
 const BIO_METHOD *BIO_s_accept(void)

diff --git a/crypto/bio/bss_conn.c b/crypto/bio/bss_conn.c
index 1ad51c8df77885245d720c641e1333e47b4695eb..e343bcddfa682f21520482a2899a8f7a45ca4d56 100644 (file)
--- a/crypto/bio/bss_conn.c
+++ b/crypto/bio/bss_conn.c
@@ -61,7 +61,7 @@ static const BIO_METHOD methods_connectp = {
     conn_write,
     conn_read,
     conn_puts,
-    NULL,                       /* connect_gets, */
+    NULL,                       /* conn_gets, */
     conn_ctrl,
     conn_new,
     conn_free,

diff --git a/crypto/bio/bss_dgram.c b/crypto/bio/bss_dgram.c
index bbf8639c648e4cafa328794148b1a0ad98d424c0..c772d956b869a3d3b6f98f03237bbe8bb0d597da 100644 (file)
--- a/crypto/bio/bss_dgram.c
+++ b/crypto/bio/bss_dgram.c
@@ -76,11 +76,11 @@ static const BIO_METHOD methods_dgramp = {
     dgram_write,
     dgram_read,
     dgram_puts,
-    NULL,                       /* dgram_gets, */
+    NULL,                       /* dgram_gets,         */
     dgram_ctrl,
     dgram_new,
     dgram_free,
-    NULL,
+    NULL,                       /* dgram_callback_ctrl */
 };
 
 # ifndef OPENSSL_NO_SCTP
@@ -90,11 +90,11 @@ static const BIO_METHOD methods_dgramp_sctp = {
     dgram_sctp_write,
     dgram_sctp_read,
     dgram_sctp_puts,
-    NULL,                       /* dgram_gets, */
+    NULL,                       /* dgram_gets,         */
     dgram_sctp_ctrl,
     dgram_sctp_new,
     dgram_sctp_free,
-    NULL,
+    NULL,                       /* dgram_callback_ctrl */
 };
 # endif
 

diff --git a/crypto/bio/bss_fd.c b/crypto/bio/bss_fd.c
index 91e720449a2531eb5f9d75dc46bf78a6c518380e..2bd3517dfda7c5e1da84f3a08615801a823a47eb 100644 (file)
--- a/crypto/bio/bss_fd.c
+++ b/crypto/bio/bss_fd.c
@@ -67,7 +67,7 @@ static const BIO_METHOD methods_fdp = {
     fd_ctrl,
     fd_new,
     fd_free,
-    NULL,
+    NULL,                       /* fd_callback_ctrl */
 };
 
 const BIO_METHOD *BIO_s_fd(void)

diff --git a/crypto/bio/bss_file.c b/crypto/bio/bss_file.c
index ee18ff31a76bec60f7b9fcc03694003acef1653b..2edf244835312f466643d8a5e8f112f964b63509 100644 (file)
--- a/crypto/bio/bss_file.c
+++ b/crypto/bio/bss_file.c
@@ -58,7 +58,7 @@ static const BIO_METHOD methods_filep = {
     file_ctrl,
     file_new,
     file_free,
-    NULL,
+    NULL,                      /* file_callback_ctrl */
 };
 
 BIO *BIO_new_file(const char *filename, const char *mode)
@@ -406,7 +406,7 @@ static const BIO_METHOD methods_filep = {
     file_ctrl,
     file_new,
     file_free,
-    NULL,
+    NULL,                      /* file_callback_ctrl */
 };
 
 const BIO_METHOD *BIO_s_file(void)

diff --git a/crypto/bio/bss_log.c b/crypto/bio/bss_log.c
index 97241e5302ecf1e54d17977a0489a57a4fa24752..5221acc2e3bc971e3f5493326ec1e669c0b698c0 100644 (file)
--- a/crypto/bio/bss_log.c
+++ b/crypto/bio/bss_log.c
@@ -1,5 +1,5 @@
 /*
- * Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 1999-2017 The OpenSSL Project Authors. All Rights Reserved.
  *
  * Licensed under the OpenSSL license (the "License").  You may not use
  * this file except in compliance with the License.  You can obtain a copy
@@ -88,13 +88,13 @@ static const BIO_METHOD methods_slg = {
     BIO_TYPE_MEM,
     "syslog",
     slg_write,
-    NULL,
+    NULL,                      /* slg_read,         */
     slg_puts,
-    NULL,
+    NULL,                      /* slg_gets,         */
     slg_ctrl,
     slg_new,
     slg_free,
-    NULL,
+    NULL,                      /* slg_callback_ctrl */
 };
 
 const BIO_METHOD *BIO_s_log(void)

diff --git a/crypto/bio/bss_mem.c b/crypto/bio/bss_mem.c
index 6dc075dc61df9537f3f3f056ab80b3041bb38c78..ff9a3ebb413fbf66ae1b02d9901ba499832c270c 100644 (file)
--- a/crypto/bio/bss_mem.c
+++ b/crypto/bio/bss_mem.c
@@ -33,7 +33,7 @@ static const BIO_METHOD mem_method = {
     mem_ctrl,
     mem_new,
     mem_free,
-    NULL,
+    NULL,                      /* mem_callback_ctrl */
 };
 
 static const BIO_METHOD secmem_method = {
@@ -46,7 +46,7 @@ static const BIO_METHOD secmem_method = {
     mem_ctrl,
     secmem_new,
     mem_free,
-    NULL,
+    NULL,                      /* mem_callback_ctrl */
 };
 
 /* BIO memory stores buffer and read pointer  */

diff --git a/crypto/bio/bss_null.c b/crypto/bio/bss_null.c
index e5c4adc874f1701d06f155a249d70201ed574c67..4dfa3f104b913eb477d43bc3a761417f2e34ee90 100644 (file)
--- a/crypto/bio/bss_null.c
+++ b/crypto/bio/bss_null.c
@@ -29,7 +29,7 @@ static const BIO_METHOD null_method = {
     null_ctrl,
     null_new,
     null_free,
-    NULL,
+    NULL,                     /* null_callback_ctrl */
 };
 
 const BIO_METHOD *BIO_s_null(void)

diff --git a/crypto/bio/bss_sock.c b/crypto/bio/bss_sock.c
index 570e8985af57aab0ccc39da22c88898f13179613..992266dc24e5677441662fbf322774fbb958920e 100644 (file)
--- a/crypto/bio/bss_sock.c
+++ b/crypto/bio/bss_sock.c
@@ -41,11 +41,11 @@ static const BIO_METHOD methods_sockp = {
     sock_write,
     sock_read,
     sock_puts,
-    NULL,                       /* sock_gets, */
+    NULL,                       /* sock_gets,         */
     sock_ctrl,
     sock_new,
     sock_free,
-    NULL,
+    NULL,                       /* sock_callback_ctrl */
 };
 
 const BIO_METHOD *BIO_s_socket(void)

diff --git a/crypto/comp/c_zlib.c b/crypto/comp/c_zlib.c
index dad4a314ccbf3c6feae0400286df76c12dbcfd9d..821dc099bb912a70bc24fad223faaf65667543d1 100644 (file)
--- a/crypto/comp/c_zlib.c
+++ b/crypto/comp/c_zlib.c
@@ -299,8 +299,8 @@ static const BIO_METHOD bio_meth_zlib = {
     "zlib",
     bio_zlib_write,
     bio_zlib_read,
-    NULL,
-    NULL,
+    NULL,                      /* bio_zlib_puts, */
+    NULL,                      /* bio_zlib_gets, */
     bio_zlib_ctrl,
     bio_zlib_new,
     bio_zlib_free,

diff --git a/ssl/bio_ssl.c b/ssl/bio_ssl.c
index 352c8a1321d9343ac4d09d2ab77f60db8b27c40f..97540e6c7cedee7f0f673d79023e707f70d5e27f 100644 (file)
--- a/ssl/bio_ssl.c
+++ b/ssl/bio_ssl.c
@@ -1,5 +1,5 @@
 /*
- * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
  *
  * Licensed under the OpenSSL license (the "License").  You may not use
  * this file except in compliance with the License.  You can obtain a copy
@@ -39,7 +39,7 @@ static const BIO_METHOD methods_sslp = {
     ssl_write,
     ssl_read,
     ssl_puts,
-    NULL,                       /* ssl_gets, */
+    NULL,                       /* ssl_gets,      */
     ssl_ctrl,
     ssl_new,
     ssl_free,