doc/man3/BIO_read.pod: clarify BIO_puts() semantics a bit

Mention that it doesn't write the terminating NUL byte (akin
to the way fputs(3) is documented[1][2]), and that it does not append
'\n', like puts(3) does.

[1] https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/functions/fputs.html
[2] https://www.man7.org/linux/man-pages/man3/fputs.3.html

Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
MergeDate: Mon Mar 16 10:54:51 2026
(Merged from https://github.com/openssl/openssl/pull/29680)

(cherry picked from commit b327b9478a004de5e1f9c86a1b4dd8f77443f249)

diff --git a/doc/man3/BIO_read.pod b/doc/man3/BIO_read.pod
index 701b3a98deef4dd1ee75bcc2716f96cd4ed176e4..5c7dd00a3450b45431cfc7930f64761cefb038cb 100644 (file)
--- a/doc/man3/BIO_read.pod
+++ b/doc/man3/BIO_read.pod
@@ -52,7 +52,9 @@ For implementing this, unfortunately the data needs to be read byte-by-byte.
 
 BIO_write() attempts to write I<len> bytes from I<buf> to BIO I<b>.
 
-BIO_puts() attempts to write a NUL-terminated string I<buf> to BIO I<b>.
+BIO_puts() attempts to write a NUL-terminated string I<buf> to BIO I<b>,
+without the terminating NUL byte and without appending '\n'
+(so, similar to fputs(3), and not puts(3)).
 
 =head1 RETURN VALUES