From: Tomas Mraz <tmraz@fedoraproject.org>
Date: Wed, 23 Nov 2016 08:33:55 +0000 (+0100)
Subject: Document that BIO_gets() preserves '\n'.
X-Git-Tag: OpenSSL_1_1_1-pre1~1504
X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=commitdiff_plain;h=bd4639bed67ddd28785899dc4ceef6b5b7fb44fd

Document that BIO_gets() preserves '\n'.

Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3442)
---

diff --git a/doc/man3/BIO_read.pod b/doc/man3/BIO_read.pod
index bd9bb8fafd..fc50069830 100644
--- a/doc/man3/BIO_read.pod
+++ b/doc/man3/BIO_read.pod
@@ -34,7 +34,8 @@ in B<buf>. Usually this operation will attempt to read a line of data
 from the BIO of maximum length B<size-1>. 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.
+The returned string is always NUL-terminated and the '\n' is preserved
+if present in the input data.
 
 BIO_write() attempts to write B<len> bytes from B<buf> to BIO B<b>.