doc: note that the BN_new() initialises the BIGNUM
authorHubert Kario <hkario@redhat.com>
Fri, 29 Sep 2017 11:10:34 +0000 (13:10 +0200)
committerHubert Kario <hkario@redhat.com>
Fri, 29 Sep 2017 11:10:34 +0000 (13:10 +0200)
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)

doc/man3/BN_new.pod

index 36bd00d..08aae5e 100644 (file)
@@ -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)>.