Commit d9a38e85 authored by Hubert Kario's avatar Hubert Kario Committed by Rich Salz
Browse files

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

backport from #4438

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4443)
parent 20d2aaf2

doc/crypto/BN_new.pod

+2 −1
Original line number Diff line number Diff line
@@ -34,7 +34,8 @@ If B<a> is NULL, nothing is done. 


=head1 RETURN VALUES



BN_new() returns a pointer to the B<BIGNUM>. If the allocation fails,

BN_new() returns a pointer to the B<BIGNUM> initialised to the value 0.

If the allocation fails,

it returns B<NULL> and sets an error code that can be obtained

by L<ERR_get_error(3)|ERR_get_error(3)>.