diff options
| author | Rich Salz <rsalz@openssl.org> | 2016-06-21 07:03:34 -0400 |
|---|---|---|
| committer | Rich Salz <rsalz@openssl.org> | 2016-06-21 07:03:34 -0400 |
| commit | c952780c25f67d0645ef5e57a8ac7dae6ce2d586 (patch) | |
| tree | 31c9e7f3c7e8f4b93337e58ab9370322e8d624e2 /doc/crypto/BN_mod_mul_reciprocal.pod | |
| parent | 6feb3c587e4bcfd73cf72da65384c310f2ee9ff2 (diff) | |
| download | openssl-new-c952780c25f67d0645ef5e57a8ac7dae6ce2d586.tar.gz | |
More doc cleanup
Add missing entries to NAME section
Add SYNOPSIS lines, remove old NAME entries
Update find-doc-nits; better regexp's for parsing SYNOPSIS sections.
Rename a couple of files to have an API name.
Remove RSA_private_decrypt; it was duplicate content
Update for recent doc additions
Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc/crypto/BN_mod_mul_reciprocal.pod')
| -rw-r--r-- | doc/crypto/BN_mod_mul_reciprocal.pod | 27 |
1 files changed, 3 insertions, 24 deletions
diff --git a/doc/crypto/BN_mod_mul_reciprocal.pod b/doc/crypto/BN_mod_mul_reciprocal.pod index 86fb486385..23832b3b6c 100644 --- a/doc/crypto/BN_mod_mul_reciprocal.pod +++ b/doc/crypto/BN_mod_mul_reciprocal.pod @@ -2,7 +2,7 @@ =head1 NAME -BN_mod_mul_reciprocal, BN_div_recp, BN_RECP_CTX_new, BN_RECP_CTX_init, +BN_mod_mul_reciprocal, BN_div_recp, BN_RECP_CTX_new, BN_RECP_CTX_free, BN_RECP_CTX_set - modular multiplication using reciprocal @@ -30,7 +30,6 @@ using B<recp>=1/B<m>, which is set as described below. B<ctx> is a previously allocated B<BN_CTX> used for temporary variables. BN_RECP_CTX_new() allocates and initializes a B<BN_RECP> structure. -BN_RECP_CTX_init() initializes an existing uninitialized B<BN_RECP>. BN_RECP_CTX_free() frees the components of the B<BN_RECP>, and, if it was created by BN_RECP_CTX_new(), also the structure itself. @@ -51,31 +50,11 @@ The B<BN_RECP_CTX> structure cannot be shared between threads. BN_RECP_CTX_new() returns the newly allocated B<BN_RECP_CTX>, and NULL on error. -BN_RECP_CTX_init() and BN_RECP_CTX_free() have no return values. +BN_RECP_CTX_free() has no return value. For the other functions, 1 is returned for success, 0 on error. The error codes can be obtained by L<ERR_get_error(3)>. -=head1 REMOVED FUNCTIONALITY - - void BN_RECP_CTX_init(BN_RECP_CTX *recp); - -BN_RECP_CTX_init() is no longer available as of OpenSSL 1.1.0. It was used to -initialize an existing uninitialized B<BN_RECP_CTX>. Typically this would be -done as follows: - - BN_RECP_CTX ctx; - BN_RECP_CTX_init(&ctx); - -Applications should replace use of BN_RECP_CTX_init with BN_RECP_CTX_new -instead: - - BN_RECP_CTX *ctx; - ctx = BN_RECP_CTX_new(); - if(!ctx) /* Handle error */ - ... - BN_RECP_CTX_free(ctx); - =head1 SEE ALSO L<bn(3)>, L<ERR_get_error(3)>, L<BN_add(3)>, @@ -83,7 +62,7 @@ L<BN_CTX_new(3)> =head1 HISTORY -BN_RECP_CTX_init was removed in OpenSSL 1.1.0 +BN_RECP_CTX_init() was removed in OpenSSL 1.1.0 =head1 COPYRIGHT |