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

Minor corrections for the RAND_DRBG API documentation #5804

Conversation

mspncp
Copy link
Contributor

@mspncp mspncp commented Mar 29, 2018

It did not take long until I found the first mistake after merging the RAND_DRBG API documentation (#5461). Here is the first correction:

  • add some explaining text to a sentence that lost its context.

Instead of pushing micro-fixes I will let this pull request hang around for a while in case more errors show up. All fixes will finally be squashed into a single commit.

Errata can be posted here, too. I will fix them.

Update: Squashed and ready for final review.


The method L<RAND_DRBG_bytes(3)> is a convenience method wrapping the
L<RAND_DRBG_generate(3)> function, which serves the actual request for
random data.
Copy link
Contributor Author

@mspncp mspncp Mar 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some time in the past, this line served as explanation for the caption <ssl->drbg> ==> RAND_DRBG_bytes(ssl->drbg, ...) in the image above. Now since that caption disappeared together with the per-ssl DRBG, this single line was orphaned and appeared to be a bit misplaced.

- added some explaining text to a sentence that lost its context.
- removed mention of per-ssl drbg
- fix whitespace errors
@mspncp mspncp force-pushed the pr-minor-corrections-for-rand-drbg-documentation branch from 7a1c75a to 239ae10 Compare April 2, 2018 12:50
@mspncp mspncp changed the title WIP: Minor corrections for the RAND_DRBG API documentation Minor corrections for the RAND_DRBG API documentation Apr 2, 2018
@mspncp mspncp added this to the 1.1.1 milestone Apr 2, 2018
@mspncp mspncp added the approval: review pending This pull request needs review by a committer label Apr 2, 2018
@mspncp
Copy link
Contributor Author

mspncp commented Apr 11, 2018

ping

@mspncp mspncp self-assigned this Apr 11, 2018
@mspncp mspncp added approval: done This pull request has the required number of approvals and removed approval: review pending This pull request needs review by a committer labels Apr 11, 2018
@mspncp
Copy link
Contributor Author

mspncp commented Apr 11, 2018

Merge, thanks!

@mspncp mspncp closed this Apr 11, 2018
@mspncp mspncp deleted the pr-minor-corrections-for-rand-drbg-documentation branch April 11, 2018 16:57
levitte pushed a commit that referenced this pull request Apr 11, 2018
- added some explaining text to a sentence that lost its context.
- removed mention of per-ssl drbg
- fix whitespace errors

Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from #5804)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approval: done This pull request has the required number of approvals
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants