summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_printf.pod
diff options
context:
space:
mode:
authorScott McPeak <scott.g.mcpeak@gmail.com>2021-04-23 03:31:54 -0700
committerPauli <pauli@openssl.org>2021-05-08 15:02:34 +1000
commit531df8185ff4a083aca550b2c8a56d7993b2c60d (patch)
tree4defb52cc8ea0d7a5f09d3310e18e46e0675be82 /doc/man3/BIO_printf.pod
parent9b53932b6fb359ad2063a640a3db3d2c5f44cfaa (diff)
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)
Diffstat (limited to 'doc/man3/BIO_printf.pod')
-rw-r--r--doc/man3/BIO_printf.pod7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/man3/BIO_printf.pod b/doc/man3/BIO_printf.pod
index d7a59a36fd..221881d123 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