From: Scott McPeak <scott.g.mcpeak@gmail.com>
Date: Fri, 23 Apr 2021 10:31:54 +0000 (-0700)
Subject: BIO_printf.pod: Clarify that output is always null terminated.
X-Git-Tag: openssl-3.0.0-alpha17~221
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=531df8185ff4a083aca550b2c8a56d7993b2c60d;p=thirdparty%2Fopenssl.git

BIO_printf.pod: Clarify that output is always null terminated.

The original text was ambiguous about termination for errors other
than insufficient space.  See issue #14772.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15000)
---

diff --git a/doc/man3/BIO_printf.pod b/doc/man3/BIO_printf.pod
index d7a59a36fd2..221881d123c 100644
--- a/doc/man3/BIO_printf.pod
+++ b/doc/man3/BIO_printf.pod
@@ -40,9 +40,10 @@ buffer is too small.
 
 =head1 NOTES
 
-Except when I<n> is 0, both BIO_snprintf() and BIO_vsnprintf() terminate
-their output with C<'\0'> even when there is insufficient space to output
-the whole string.
+Except when I<n> is 0, both BIO_snprintf() and BIO_vsnprintf() always
+terminate their output with C<'\0'>.  This includes cases where -1 is
+returned, such as when there is insufficient space to output the whole
+string.
 
 =head1 COPYRIGHT