]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: clarify OSSL_DISPATCH array usage in provider-base
authorkovan <xaum.io@gmail.com>
Tue, 27 Jan 2026 05:01:49 +0000 (06:01 +0100)
committerTomas Mraz <tomas@openssl.org>
Tue, 3 Feb 2026 09:47:25 +0000 (10:47 +0100)
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)

doc/man7/provider-base.pod

index 023ac12f68f401967492de1ae1378f00fc4ab681..5c185403070b04ac157b75c736cea75aab3add21 100644 (file)
@@ -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