doc/man3/OSSL_PARAM.pod: add details about multiple elements with same key
authorRichard Levitte <levitte@openssl.org>
Sat, 31 Aug 2019 07:30:43 +0000 (09:30 +0200)
committerRichard Levitte <levitte@openssl.org>
Thu, 12 Sep 2019 11:30:09 +0000 (13:30 +0200)
Usually, each element in an OSSL_PARAM array will have a unique key.
However, there may be some rare cases when a responder will handle
multiple elements with the same key.  This adds a short passage
explaining this case.

Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9741)

doc/man3/OSSL_PARAM.pod

index d0725e063e811b393a9d2f982dd38f8ecef21b67..361028fa00d7b2feb1ddb71e414cd65b3e89d613 100644 (file)
@@ -60,6 +60,10 @@ I<responder>.
 
 =back
 
+Normally, the order of the an B<OSSL_PARAM> array is not relevant.
+However, if the I<responder> can handle multiple elements with the
+same key, those elements must be handled in the order they are in.
+
 =head2 B<OSSL_PARAM> fields
 
 =over 4