summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2021-11-14 13:40:17 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2021-11-14 13:40:17 +0000
commita7af4542d4c7bb5c0dfb4fec7b5201cc237989f9 (patch)
treeaa6fc6f9a5fc78dba3dfb2c6bda9bf2be60a0aca /lib
parent835ed096ea80fa69254f17e2f0cebb27de740d8f (diff)
the last argument of BIO_gets(3) is called "size", not "len"
Diffstat (limited to 'lib')
-rw-r--r--lib/libcrypto/man/BIO_read.312
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/libcrypto/man/BIO_read.3 b/lib/libcrypto/man/BIO_read.3
index 97514a610a2..3f059b5d54f 100644
--- a/lib/libcrypto/man/BIO_read.3
+++ b/lib/libcrypto/man/BIO_read.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_read.3,v 1.8 2018/03/27 17:35:50 schwarze Exp $
+.\" $OpenBSD: BIO_read.3,v 1.9 2021/11/14 13:40:16 schwarze Exp $
.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
.\"
.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -48,7 +48,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: March 27 2018 $
+.Dd $Mdocdate: November 14 2021 $
.Dt BIO_READ 3
.Os
.Sh NAME
@@ -96,7 +96,7 @@ performs the BIOs "gets" operation and places the data in
.Fa buf .
Usually this operation will attempt to read a line of data
from the BIO of maximum length
-.Fa len No - 1 .
+.Fa size No \- 1 .
There are exceptions to this however, for example
.Fn BIO_gets
on a digest BIO will calculate and return the digest
@@ -154,13 +154,13 @@ to the chain.
.Sh RETURN VALUES
All these functions return either the amount of data successfully
read or written (if the return value is positive) or that no data
-was successfully read or written if the result is 0 or -1.
-If the return value is -2, then the operation is not implemented
+was successfully read or written if the result is 0 or \-1.
+If the return value is \-2, then the operation is not implemented
in the specific BIO type.
The trailing NUL is not included in the length returned by
.Fn BIO_gets .
.Pp
-A 0 or -1 return is not necessarily an indication of an error.
+A 0 or \-1 return is not necessarily an indication of an error.
In particular when the source/sink is non-blocking or of a certain type
it may merely be an indication that no data is currently available and that
the application should retry the operation later.