DOC: Add note on how to terminate an OSSL_PARAM array #13478
Closed
Conversation
The examples are also updated to have correct terminators. doc/man3/OSSL_PARAM.pod is deliberately written with no help from the constructor macros described in OSSL_PARAM_int.pod. Therefore, OSSL_PARAM_END isn't mentioned in this page, however tempting that may be. Fixes #11280
This seems like a bad approach to me. Why wouldnt it say something along the lines of |
|
Yeah ok, I can do that |
|
Done |
Change the commit message by replacing this sentence:
Therefore, OSSL_PARAM_END isn't mentioned in this page, however
tempting that may be.
with:
Therefore, use of OSSL_PARAM_END isn't shown directly here, only
leaving a link to its man-page to indicate that there is that
option.
|
This pull request is ready to merge |
|
Merged c589c14 DOC: Add note on how to terminate an OSSL_PARAM array |
openssl-machine
pushed a commit
that referenced
this pull request
Nov 26, 2020
The examples are also updated to have correct terminators. doc/man3/OSSL_PARAM.pod is deliberately written with no help from the constructor macros described in OSSL_PARAM_int.pod. Therefore, use of OSSL_PARAM_END isn't shown directly here, only leaving a link to its man-page to indicate that there is that option. Fixes #11280 Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from #13478)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
The examples are also updated to have correct terminators.
doc/man3/OSSL_PARAM.pod is deliberately written with no help from the
constructor macros described in OSSL_PARAM_int.pod. Therefore,
OSSL_PARAM_END isn't mentioned in this page, however tempting that may
be.
Fixes #11280
Inspired by #13215, and an alternative to it.