doc: describe the return from ossl_provider_forall_loaded()

Also correct an incorrect statement about non-activated providers.

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14489)

diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod
index dbf1e7cc5a7aeef7fcda6c04bc4a4cdbb2c2dfd3..43ad7556cfa519bf5aa2bb89b219bc7dc03252db 100644 (file)
--- a/doc/internal/man3/ossl_provider_new.pod
+++ b/doc/internal/man3/ossl_provider_new.pod
@@ -200,7 +200,7 @@ passed back to some of the provider functions.
 ossl_provider_forall_loaded() iterates over all the currently
 "activated" providers, and calls I<cb> for each of them.
 If no providers have been "activated" yet, it tries to activate all
-available fallback providers and tries another iteration.
+available fallback providers before iterating over them.
 
 ossl_provider_name() returns the name that was given with
 ossl_provider_new().
@@ -287,6 +287,10 @@ it has been incremented.
 
 ossl_provider_free() doesn't return any value.
 
+ossl_provider_forall_loaded() returns 1 if the callback was called for all
+activated providers.  A return value of 0 means that the callback was not
+called for any activated providers.
+
 ossl_provider_set_module_path(), ossl_provider_set_fallback(),
 ossl_provider_activate(), ossl_provider_activate_leave_fallbacks() and
 ossl_provider_deactivate() return 1 on success, or 0 on error.