diff options
| author | Pauli <paul.dale@oracle.com> | 2020-04-07 15:50:02 +1000 |
|---|---|---|
| committer | Pauli <paul.dale@oracle.com> | 2020-04-08 18:00:36 +1000 |
| commit | 82e1fc1bc06a87278b2dada07e40a4296e6898c7 (patch) | |
| tree | 01fb2180640953a5727a30266eda57ab7c147325 /doc | |
| parent | 069165d10646a22000c596095cc04d43bbf1f807 (diff) | |
params: add a warning about the PTR types.
The warning is deter the unsure -- if in doubt the PTR type is almost certainly
NOT what you should be using.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/11480)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_PARAM.pod | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/man3/OSSL_PARAM.pod b/doc/man3/OSSL_PARAM.pod index cd7d41006b..a2392a9609 100644 --- a/doc/man3/OSSL_PARAM.pod +++ b/doc/man3/OSSL_PARAM.pod @@ -159,6 +159,9 @@ The parameter data is a pointer to a printable string. The difference between this and B<OSSL_PARAM_UTF8_STRING> is that I<data> doesn't point directly at the data, but to a pointer that points to the data. +If there is any uncertainty about which to use, B<OSSL_PARAM_UTF8_STRING> is +almost certainly the correct choice. + This is used to indicate that constant data is or will be passed, and there is therefore no need to copy the data that is passed, just the pointer to it. @@ -182,6 +185,9 @@ The difference between this and B<OSSL_PARAM_OCTET_STRING> is that I<data> doesn't point directly at the data, but to a pointer that points to the data. +If there is any uncertainty about which to use, B<OSSL_PARAM_OCTET_STRING> is +almost certainly the correct choice. + This is used to indicate that constant data is or will be passed, and there is therefore no need to copy the data that is passed, just the pointer to it. |