summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2022-12-21 15:08:38 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2022-12-21 15:08:38 +0000
commit9046446e8ab7dbbaaee5f8f848184dcbf2853c6b (patch)
treeeba23213f3b744eb993e4e8da2d38dfda50a3ed3 /lib/libcrypto/man
parent1223e9cc529087842ad4f3de58c88e6d722e63dd (diff)
Mark BIO_nread0(3), BIO_nread(3), BIO_nwrite0(3), and BIO_nwrite(3)
as intentionally undocumented. Bodo Moeller invented this "non-copying I/O" API in 1999, but according to codesearch.debian.net, it is still completely unused by anything. On top of that, it appears to be inflexible in so far as it only supports BIO pairs and no other BIO types and fragile in so far as it exposes pointers to internal storage and runs contrary to expectations of how BIO objects are supposed to work.
Diffstat (limited to 'lib/libcrypto/man')
-rw-r--r--lib/libcrypto/man/BIO_s_bio.310
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/libcrypto/man/BIO_s_bio.3 b/lib/libcrypto/man/BIO_s_bio.3
index 3c5b1fbe108..227828e2f99 100644
--- a/lib/libcrypto/man/BIO_s_bio.3
+++ b/lib/libcrypto/man/BIO_s_bio.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_s_bio.3,v 1.15 2022/12/18 19:35:36 schwarze Exp $
+.\" $OpenBSD: BIO_s_bio.3,v 1.16 2022/12/21 15:08:37 schwarze Exp $
.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
.\"
.\" This file was written by
@@ -53,7 +53,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: December 18 2022 $
+.Dd $Mdocdate: December 21 2022 $
.Dt BIO_S_BIO 3
.Os
.Sh NAME
@@ -69,6 +69,12 @@
.Nm BIO_get_read_request ,
.Nm BIO_ctrl_get_read_request ,
.Nm BIO_ctrl_reset_read_request
+.\" The following non-copying I/O functions are intentionally undocumented
+.\" because they seem fragile and unused by anything:
+.\" .Nm BIO_nread0
+.\" .Nm BIO_nread
+.\" .Nm BIO_nwrite0
+.\" .Nm BIO_nwrite
.Nd BIO pair BIO
.Sh SYNOPSIS
.In openssl/bio.h