From 6be630b9c514bd19eb695c7085d06ed7dbb34f4e Mon Sep 17 00:00:00 2001 From: Benjamin Kaduk Date: Tue, 29 Mar 2016 14:56:44 -0500 Subject: [PATCH] Clarify the behavior of BIO_gets() a bit more The API contract is more tight than was previously documented -- the returned string must be NUL-terminated, and the supplied buffer includes space for the trailing NUL, so the maximum length that can be read in is reduced. Clarify that the NUL is not included in the returned length, and fix the spelling of "NUL-terminated" in a nearby spot. Adjust punctuation to make a modest improvement to the grammar. Reviewed-by: Matt Caswell Reviewed-by: Rich Salz --- doc/crypto/BIO_read.pod | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/crypto/BIO_read.pod b/doc/crypto/BIO_read.pod index 09ee39fc6d..90b1c7520f 100644 --- a/doc/crypto/BIO_read.pod +++ b/doc/crypto/BIO_read.pod @@ -20,20 +20,22 @@ the data in B. BIO_gets() performs the BIOs "gets" operation and places the data in B. Usually this operation will attempt to read a line of data -from the BIO of maximum length B. There are exceptions to this -however, for example BIO_gets() on a digest BIO will calculate and +from the BIO of maximum length B. There are exceptions to this, +however; for example, BIO_gets() on a digest BIO will calculate and return the digest and other BIOs may not support BIO_gets() at all. +The returned string is always NUL-terminated. BIO_write() attempts to write B bytes from B to BIO B. -BIO_puts() attempts to write a null terminated string B to BIO B. +BIO_puts() attempts to write a NUL-terminated string B to BIO B. =head1 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 in the specific BIO type. +the operation is not implemented in the specific BIO type. The trailing +NUL is not included in the length returned by BIO_gets(). =head1 NOTES -- 2.34.1