From: Pauli Date: Wed, 24 Mar 2021 03:12:40 +0000 (+1000) Subject: doc: note that RAND lifecycle transitions will be enforced at some point X-Git-Tag: openssl-3.0.0-alpha14~122 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=632bc4dff3856374192052871c39b24032b17728;p=thirdparty%2Fopenssl.git doc: note that RAND lifecycle transitions will be enforced at some point Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/14522) --- diff --git a/doc/man3/EVP_RAND.pod b/doc/man3/EVP_RAND.pod index 52cf5118d86..f550ec18e3c 100644 --- a/doc/man3/EVP_RAND.pod +++ b/doc/man3/EVP_RAND.pod @@ -336,6 +336,10 @@ An B needs to have locking enabled if it acts as the parent of more than one child and the children can be accessed concurrently. This must be done by explicitly calling EVP_RAND_enable_locking(). +The RAND life-cycle is described in L. In the future, +the transitions described there will be enforced. When this is done, it will +not be considered a breaking change to the API. + =head1 RETURN VALUES EVP_RAND_fetch() returns a pointer to a newly fetched B, or @@ -382,7 +386,8 @@ L, L, L, L, -L +L, +L =head1 HISTORY diff --git a/doc/man7/provider-rand.pod b/doc/man7/provider-rand.pod index be812376100..951f483b60a 100644 --- a/doc/man7/provider-rand.pod +++ b/doc/man7/provider-rand.pod @@ -272,11 +272,19 @@ error. All of the remaining functions should return 1 for success or 0 on error. +=head1 NOTES + +The RAND life-cycle is described in L. Providers should +ensure that the various transitions listed there are supported. At some point +the EVP layer will begin enforcing the listed transitions. + =head1 SEE ALSO L, L, -L +L, +L, +L =head1 HISTORY