Skip to content

Clarify the EVP_DigestSignInit docs#7042

Closed
mattcaswell wants to merge 2 commits intoopenssl:masterfrom
mattcaswell:clarify-digestsigninit-docs
Closed

Clarify the EVP_DigestSignInit docs#7042
mattcaswell wants to merge 2 commits intoopenssl:masterfrom
mattcaswell:clarify-digestsigninit-docs

Conversation

@mattcaswell
Copy link
Member

They did not make it clear how the memory management works for the |pctx|
parameter.

Fixes #7037

They did not make it clear how the memory management works for the |pctx|
parameter.

Fixes openssl#7037
@mattcaswell mattcaswell added branch: master Applies to master branch 1.1.0 branch: 1.1.1 Applies to OpenSSL_1_1_1-stable branch (EOL) labels Aug 23, 2018
@mattcaswell
Copy link
Member Author

See also #7043 for 1.0.2 version

@@ -26,8 +26,10 @@ EVP_DigestSignInit() sets up signing context B<ctx> to use digest B<type> from
ENGINE B<e> and private key B<pkey>. B<ctx> must be created with
EVP_MD_CTX_new() before calling this function. If B<pctx> is not NULL the
Copy link
Contributor

@parasssh parasssh Aug 23, 2018

Choose a reason for hiding this comment

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

nit:
While you are at it, need a comma after the word "NULL"

@parasssh
Copy link
Contributor

@mattcaswell , you might want to edit the EVP_DigestVerifyInit() docs as well.

@t-j-h t-j-h added this to the 1.1.1 milestone Sep 1, 2018
@t-j-h
Copy link
Member

t-j-h commented Sep 1, 2018

Note an issue with a 1.1.1 milestone referenced this PR so I added the 1.1.1 milestone to the PR to make it clear. If the issue gets reclassified then this PR should also

@mattcaswell mattcaswell force-pushed the clarify-digestsigninit-docs branch from c2c5063 to 1d28666 Compare September 3, 2018 14:24
@mattcaswell
Copy link
Member Author

Updated to take account of comments from @parasssh. @t-j-h please can you reconfirm?

@mattcaswell
Copy link
Member Author

I removed the 1.1.1 milestone from the referencing issue, so I removed it from here too.

@mattcaswell mattcaswell modified the milestones: 1.1.1, Assessed Sep 3, 2018
levitte pushed a commit that referenced this pull request Sep 4, 2018
They did not make it clear how the memory management works for the |pctx|
parameter.

Fixes #7037

Reviewed-by: Tim Hudson <[email protected]>
(Merged from #7042)

(cherry picked from commit f097e87)
@mattcaswell
Copy link
Member Author

Pushed to master and 1.1.0. Thanks.

@mattcaswell mattcaswell closed this Sep 4, 2018
levitte pushed a commit that referenced this pull request Sep 4, 2018
They did not make it clear how the memory management works for the |pctx|
parameter.

Fixes #7037

Reviewed-by: Tim Hudson <[email protected]>
(Merged from #7042)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch: master Applies to master branch branch: 1.1.1 Applies to OpenSSL_1_1_1-stable branch (EOL)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants