X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fcrypto%2FBN_CTX_new.pod;h=c94d8c610da5804de25a73d5b40327721cde09fb;hp=f9ded384e2efe98127058b37bfe0d7a633293568;hb=18edda0f927e6919c1cff2d6e456cb8a0776239b;hpb=bb075f883356589425b7e57f788c7498a83b0219 diff --git a/doc/crypto/BN_CTX_new.pod b/doc/crypto/BN_CTX_new.pod index f9ded384e2..c94d8c610d 100644 --- a/doc/crypto/BN_CTX_new.pod +++ b/doc/crypto/BN_CTX_new.pod @@ -16,17 +16,21 @@ BN_CTX_new, BN_CTX_init, BN_CTX_free - allocate and free BN_CTX structures =head1 DESCRIPTION -A B is a structure that holds temporary variables used by -library functions. Thus, it can be avoided to create and destroy -the temporary B objects whenever a library function is -called. +A B is a structure that holds B temporary variables used by +library functions. Since dynamic memory allocation to create Bs +is rather expensive when used in conjunction with repeated subroutine +calls, the B structure is used. -BN_CTX_new() allocated and initializes a B +BN_CTX_new() allocates and initializes a B structure. BN_CTX_init() initializes an existing uninitialized B. BN_CTX_free() frees the components of the B, and if it was created by BN_CTX_new(), also the structure itself. +If L has been used on the B, +L must be called before the B +may be freed by BN_CTX_free(). + =head1 RETURN VALUES @@ -38,11 +42,12 @@ BN_CTX_init() and BN_CTX_free() have no return values. =head1 SEE ALSO -L, L, L +L, L, L, +L =head1 HISTORY -BN_CTX_new() and BN_CTX_free() are availabe in all versions on SSLeay +BN_CTX_new() and BN_CTX_free() are available in all versions on SSLeay and OpenSSL. BN_CTX_init() was added in SSLeay 0.9.1b. =cut