From: Hubert Kario <hkario@redhat.com>
Date: Fri, 29 Sep 2017 11:10:34 +0000 (+0200)
Subject: doc: note that the BN_new() initialises the BIGNUM
X-Git-Tag: OpenSSL_1_1_1-pre1~612
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=681acb311bb7c68c9310d2e96bf2cf0e35443a22;p=oweals%2Fopenssl.git

doc: note that the BN_new() initialises the BIGNUM

BN_new() and BN_secure_new() not only allocate memory, but also
initialise it to deterministic value - 0.

Document that behaviour to make it explicit

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

diff --git a/doc/man3/BN_new.pod b/doc/man3/BN_new.pod
index 36bd00da28..08aae5e919 100644
--- a/doc/man3/BN_new.pod
+++ b/doc/man3/BN_new.pod
@@ -36,7 +36,8 @@ If B<a> is NULL, nothing is done.
 =head1 RETURN VALUES
 
 BN_new() and BN_secure_new()
-return a pointer to the B<BIGNUM>. If the allocation fails,
+return a pointer to the B<BIGNUM> initialised to the value 0.
+If the allocation fails,
 they return B<NULL> and set an error code that can be obtained
 by L<ERR_get_error(3)>.