man EVP_PKEY_CTX_set_params: document params is a list

[tomato42]

Make it clear in the man page that the parameters field in EVP_PKEY_CTX_set_params are a pointer to a list, not to a single struct.

Checklist

• documentation is added or updated

[beldmit]

LGTM though it looks obvious to me

[t8m]

Use I<params> and B<OSSL_PARAM> please.

[tomato42]

sure, fixed

[slontis]

transfer of 'arbitrary key parameters' gives a good indication that it is a list.

We should probably do this generically because there are a lot of these setter/getters.

In multiple places this is handled as
'See L<OSSL_PARAM(3)> for information about passing parameters'

[tom-cosgrove-arm]

@t8m are you reviewing this? I think this is useful if only for the "terminated with a L<OSSL_PARAM_END(3)> struct" bit

[tomato42]

I've proposed this change because it wasn't obvious to my colleague and to me, and had to actually experiment to understand how to use the API. So, if not being explicit about this is stuff in openssl man pages is the policy, I'd say it's a bad policy for documentation aimed at people beginning programming with OpenSSL API.

[slontis]

If you added what I suggested and then read it, it should be understandable. My point is that there are a lot of set and get params calls. Fixing it in one place its less than ideal.

[tomato42]

@slontis sorry, given that the man page already has See L<OSSL_PARAM(3)> for more information on parameters. I didn't read your comment as a suggestion to change it to See L<OSSL_PARAM(3)> for information about passing parameters. Are you saying I should make this change too?

[tomato42]

@slontis Fixed (BTW: I don't think that a 👍 shows up in notifications)

[beldmit]

Still LGTM

[tomato42]

the failure doesn't look at all to be related to the changes:

libcrypto.a(libcrypto-lib-cmp_util.o): in function `ossl_cmp_log_parse_metadata':
cmp_util.c:(.text+0x22e): relocation truncated to fit: R_68K_GOT16O against `.LC9'
libcrypto.a(libcrypto-lib-cmp_util.o): in function `ossl_cmp_X509_STORE_add1_certs':
cmp_util.c:(.text+0x6f6): relocation truncated to fit: R_68K_GOT16O against `.LC9'
libcrypto.a(libcrypto-lib-cmp_util.o): in function `ossl_cmp_asn1_octet_string_set1':
cmp_util.c:(.text+0x7f2): relocation truncated to fit: R_68K_GOT16O against `.LC9'
libcrypto.a(libcrypto-lib-cmp_util.o): in function `ossl_cmp_asn1_octet_string_set1_bytes':
cmp_util.c:(.text+0x8ae): relocation truncated to fit: R_68K_GOT16O against `.LC9'
collect2: error: ld returned 1 exit status
make[1]: *** [Makefile:30816: test/ssl_old_test] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:3680: build_sw] Error 2

[openssl-machine]

24 hours has passed since 'approval: done' was set, but as this PR has been updated in that time the label 'approval: ready to merge' is not being automatically set. Please review the updates and set the label manually.

[t8m]

Merged to all the active branches. Thank you.