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.

Sign up for GitHub

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

Jump to bottom

Rework the documentation of our individual MAC implementations #9713

Closed
wants to merge 3 commits into from
Closed

Rework the documentation of our individual MAC implementations #9713

wants to merge 3 commits into from

Conversation

levitte
Copy link
Member

@levitte levitte commented Aug 28, 2019

We now describe parameters instead of controls.

Also, since macros like EVP_MAC_CMAC do not exist any more, we rename
the pod files from EVP_MAC_{algo}.pod to EVP_MAC-{algo}.pod. This
allows getting the documentation like this:

man EVP_MAC CMAC

[skip ci]
Fixes #9709

@levitte
Rework the documentation of our individual MAC implementations
f56e635 
We now describe parameters instead of controls.

Also, since macros like EVP_MAC_CMAC do not exist any more, we rename
the pod files from EVP_MAC_{algo}.pod to EVP_MAC-{algo}.pod.  This
allows getting the documentation like this:

    man EVP_MAC CMAC

[skip ci]
Fixes openssl#9709
@levitte levitte added the branch: master Merge to master branch label Aug 28, 2019
@levitte levitte mentioned this pull request Aug 28, 2019
Closed
slontis
slontis reviewed Aug 28, 2019
View reviewed changes
doc/man3/EVP_MAC.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Aug 28, 2019
View reviewed changes
Copy link
Member

@slontis slontis left a comment

Choose a reason for hiding this comment

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

Apart from a little NIT, it looks ok to me..
I assume you run make doc-nits if you are skipping testing?

@levitte
Copy link
Member Author

levitte commented Aug 28, 2019

I assume you run make doc-nits if you are skipping testing?

Actually, that was to avoid CIs to do unnecessary work. They are a finite resource, after all

@levitte
Copy link
Member Author

levitte commented Aug 28, 2019

However, a quick doc-nits revealed no errors

@richsalz
Copy link
Contributor

"in the form of" --> "as"

@levitte
Copy link
Member Author

levitte commented Aug 28, 2019

"in the form of" --> "as"

Thanks. Changed.

@levitte
Copy link
Member Author

levitte commented Sep 2, 2019 •
edited

Ping? Never mind, github glitch didn't show me the approval

levitte added a commit that referenced this pull request Sep 2, 2019
@levitte
Rework the documentation of our individual MAC implementations
e592dbd 
We now describe parameters instead of controls.

Also, since macros like EVP_MAC_CMAC do not exist any more, we rename
the pod files from EVP_MAC_{algo}.pod to EVP_MAC-{algo}.pod.  This
allows getting the documentation like this:

    man EVP_MAC CMAC

[skip ci]
Fixes #9709

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from #9713)
@levitte
Copy link
Member Author

levitte commented Sep 2, 2019

Merged.

e592dbd Rework the documentation of our individual MAC implementations

@levitte levitte closed this Sep 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slontis slontis slontis approved these changes

Assignees
No one assigned
Labels
branch: master Merge to master branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

MAC documenation needs updating
3 participants
@levitte @richsalz @slontis