Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add note on how to terminate an OSSL_PARAM array #13478

Closed
wants to merge 2 commits into from

Conversation

@levitte
Copy link
Member

@levitte levitte commented Nov 23, 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,
OSSL_PARAM_END isn't mentioned in this page, however tempting that may
be.

Fixes #11280


Inspired by #13215, and an alternative to it.

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
@levitte levitte added this to the 3.0.0 milestone Nov 23, 2020
@levitte levitte added this to In progress in 3.0 New Core + FIPS via automation Nov 23, 2020
@slontis
Copy link
Contributor

@slontis slontis commented Nov 23, 2020

Therefore, OSSL_PARAM_END isn't mentioned in this page, however tempting that may be.

This seems like a bad approach to me. Why wouldnt it say something along the lines of
This can also be specified using <OSSL_PARAM_int(3)/OSSL_PARAM_END>?

@levitte
Copy link
Member Author

@levitte levitte commented Nov 24, 2020

Yeah ok, I can do that

@levitte
Copy link
Member Author

@levitte levitte commented Nov 24, 2020

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.
@openssl-machine
Copy link

@openssl-machine openssl-machine commented Nov 25, 2020

This pull request is ready to merge

3.0 New Core + FIPS automation moved this from In progress to Reviewer approved Nov 25, 2020
@levitte
Copy link
Member Author

@levitte levitte commented Nov 26, 2020

Merged

c589c14 DOC: Add note on how to terminate an OSSL_PARAM array

@levitte levitte closed this Nov 26, 2020
3.0 New Core + FIPS automation moved this from Reviewer approved to Done Nov 26, 2020
@levitte levitte deleted the levitte:fix-11280 branch Nov 26, 2020
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
Projects
Linked issues

Successfully merging this pull request may close these issues.

4 participants