aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorShane Lontis <shane.lontis@oracle.com>2021-04-07 13:45:19 +1000
committerShane Lontis <shane.lontis@oracle.com>2021-04-12 16:55:30 +1000
commit3f883c7c835ff577a6df37e238956c5b9016dc93 (patch)
tree53981bf279887c1dc043e264cbaa61710b75c2b9 /doc
parent884314cab786a980189206b2cab5f62878a97669 (diff)
downloadopenssl-3f883c7c835ff577a6df37e238956c5b9016dc93.tar.gz
Replace OSSL_PARAM_BLD_free_params() with OSSL_PARAM_free().
Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14785)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/EVP_PKEY_fromdata.pod2
-rw-r--r--doc/man3/OSSL_PARAM_BLD.pod14
2 files changed, 6 insertions, 10 deletions
diff --git a/doc/man3/EVP_PKEY_fromdata.pod b/doc/man3/EVP_PKEY_fromdata.pod
index 40f39d7c68..1c85474662 100644
--- a/doc/man3/EVP_PKEY_fromdata.pod
+++ b/doc/man3/EVP_PKEY_fromdata.pod
@@ -198,7 +198,7 @@ TODO Write a set of cookbook documents and link to them.
EVP_PKEY_free(pkey);
EVP_PKEY_CTX_free(ctx);
- OSSL_PARAM_BLD_free_params(params);
+ OSSL_PARAM_free(params);
OSSL_PARAM_BLD_free(param_bld);
BN_free(priv);
diff --git a/doc/man3/OSSL_PARAM_BLD.pod b/doc/man3/OSSL_PARAM_BLD.pod
index 0a44fa63fb..9190e81c01 100644
--- a/doc/man3/OSSL_PARAM_BLD.pod
+++ b/doc/man3/OSSL_PARAM_BLD.pod
@@ -3,7 +3,7 @@
=head1 NAME
OSSL_PARAM_BLD, OSSL_PARAM_BLD_new, OSSL_PARAM_BLD_to_param,
-OSSL_PARAM_BLD_free_params, OSSL_PARAM_BLD_free, OSSL_PARAM_BLD_push_int,
+OSSL_PARAM_BLD_free, OSSL_PARAM_BLD_push_int,
OSSL_PARAM_BLD_push_uint, OSSL_PARAM_BLD_push_long,
OSSL_PARAM_BLD_push_ulong, OSSL_PARAM_BLD_push_int32,
OSSL_PARAM_BLD_push_uint32, OSSL_PARAM_BLD_push_int64,
@@ -24,7 +24,6 @@ OSSL_PARAM_BLD_push_octet_string, OSSL_PARAM_BLD_push_octet_ptr
OSSL_PARAM_BLD *OSSL_PARAM_BLD_new(void);
OSSL_PARAM *OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD *bld);
- void OSSL_PARAM_BLD_free_params(OSSL_PARAM *params);
void OSSL_PARAM_BLD_free(OSSL_PARAM_BLD *bld);
int OSSL_PARAM_BLD_push_TYPE(OSSL_PARAM_BLD *bld, const char *key, TYPE val);
@@ -58,12 +57,9 @@ OSSL_PARAM_BLD_free() deallocates the memory allocates by OSSL_PARAM_BLD_new().
OSSL_PARAM_BLD_to_param() converts a built up OSSL_PARAM_BLD structure
I<bld> into an allocated OSSL_PARAM array.
The OSSL_PARAM array and all associated storage must be freed by calling
-OSSL_PARAM_BLD_free_params() with the functions return value.
+OSSL_PARAM_free() with the functions return value.
OSSL_PARAM_BLD_free() can safely be called any time after this function is.
-OSSL_PARAM_BLD_free_params() deallocates the memory allocated by
-OSSL_PARAM_BLD_to_param().
-
=begin comment
POD is pretty good at recognising function names and making them appropriately
@@ -155,7 +151,7 @@ private key.
OSSL_PARAM_BLD_free(bld);
/* Use params */
...
- OSSL_PARAM_BLD_free_params(params);
+ OSSL_PARAM_free(params);
=head2 Example 2
@@ -173,11 +169,11 @@ public key.
OSSL_PARAM_BLD_free(bld);
/* Use params */
...
- OSSL_PARAM_BLD_free_params(params);
+ OSSL_PARAM_free(params);
=head1 SEE ALSO
-L<OSSL_PARAM_int(3)>, L<OSSL_PARAM(3)>
+L<OSSL_PARAM_int(3)>, L<OSSL_PARAM(3)>, L<OSSL_PARAM_free(3)>
=head1 HISTORY