doc: note that RAND lifecycle transitions will be enforced at some point

Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14522)

diff --git a/doc/man3/EVP_RAND.pod b/doc/man3/EVP_RAND.pod
index 52cf5118d86166a1aa6506bc1f04c91f44838855..f550ec18e3c04809760b33d852fcd6e3e43ecbe8 100644 (file)
--- a/doc/man3/EVP_RAND.pod
+++ b/doc/man3/EVP_RAND.pod
@@ -336,6 +336,10 @@ An B<EVP_RAND_CTX> 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<life_cycle-rand(7)>.  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<EVP_RAND>, or
@@ -382,7 +386,8 @@ L<EVP_RAND-CTR-DRBG(7)>,
 L<EVP_RAND-HASH-DRBG(7)>,
 L<EVP_RAND-HMAC-DRBG(7)>,
 L<EVP_RAND-TEST-RAND(7)>,
-L<provider-rand(7)>
+L<provider-rand(7)>,
+L<life_cycle-rand(7)>
 
 =head1 HISTORY
 

diff --git a/doc/man7/provider-rand.pod b/doc/man7/provider-rand.pod
index be8123761008037b782deb0a67367ee890d75dc6..951f483b60ab01d0411954e313bcf4267bf931a5 100644 (file)
--- 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<life_cycle-rand(7)>.  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<provider(7)>,
 L<RAND(7)>,
-L<EVP_RAND(7)>
+L<EVP_RAND(7)>,
+L<life_cycle-rand(7)>,
+L<EVP_RAND(3)>
 
 =head1 HISTORY