Commit 88d39f33d1 for openssl.org
commit 88d39f33d1ab88796204136370868776d4fcb706
Author: kovan <xaum.io@gmail.com>
Date: Tue Jan 27 06:01:49 2026 +0100
doc: clarify OSSL_DISPATCH array usage in provider-base
The previous wording "arrays are indexed by numbers" was misleading
as it suggested direct array indexing. Clarify that OSSL_DISPATCH
entries contain a function_id field that identifies the function.
Fixes #27125
CLA: trivial
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
MergeDate: Tue Feb 3 09:48:02 2026
(Merged from https://github.com/openssl/openssl/pull/29769)
diff --git a/doc/man7/provider-base.pod b/doc/man7/provider-base.pod
index 023ac12f68..5c18540307 100644
--- a/doc/man7/provider-base.pod
+++ b/doc/man7/provider-base.pod
@@ -141,7 +141,8 @@ For example, the "function" core_gettable_params() has these:
static ossl_inline OSSL_NAME_core_gettable_params_fn
OSSL_FUNC_core_gettable_params(const OSSL_DISPATCH *opf);
-L<OSSL_DISPATCH(3)> arrays are indexed by numbers that are provided as
+L<OSSL_DISPATCH(3)> array entries contain a I<function_id> field that
+identifies the function. The I<function_id> numbers are provided as
macros in L<openssl-core_dispatch.h(7)>, as follows:
For I<in> (the L<OSSL_DISPATCH(3)> array passed from F<libcrypto> to the