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

Fix some documentation errors #16553

Closed
wants to merge 1 commit into from

Conversation

PeiweiHu
Copy link
Contributor

@PeiweiHu PeiweiHu commented Sep 8, 2021

CLA:trivial

There are 3 changes within the pr:

  • Fix documentation: doc/man3/OSSL_HTTP_REQ_CTX.pod

    Function OSSL_HTTP_REQ_CTX_free will free wbio if rctx->free_wbio is set while documentation says The wbio and rbio are not free'd. This may lead to misuse of freed object.

  • Fix documentation: doc/man3/OSSL_CMP_MSG_get0_header.pod

    Old function defination of OSSL_CMP_MSG_read. Note that some other new functions origins from commit c631378 may also need to be added to documentation.

  • Fix documentation: doc/man3/ASN1_item_d2i_bio.pod

    Some parameters' names are not consistent with source code.

Checklist
  • documentation is added or updated
  • tests are added or updated

@openssl-machine openssl-machine added the hold: cla required The contributor needs to submit a license agreement label Sep 8, 2021
Copy link
Contributor

@paulidale paulidale left a comment

Choose a reason for hiding this comment

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

I think this is within the bounds of being trivial.

You will need the CLA: trivial line in the commit message, not the GitHub pull request. git commit --amend will let you edit the message -- just add a the required line. git push -f will push the modified message here and the need CLA tag should disappear.

@paulidale paulidale added the cla: trivial One of the commits is marked as 'CLA: trivial' label Sep 8, 2021
@openssl-machine openssl-machine removed the hold: cla required The contributor needs to submit a license agreement label Sep 8, 2021
Copy link
Member

@t8m t8m left a comment

Choose a reason for hiding this comment

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

I am OK with CLA: trivial.

Good for master and 3.0 branches.

@t8m t8m added branch: 3.0 Merge to openssl-3.0 branch branch: master Merge to master branch approval: done This pull request has the required number of approvals triaged: documentation The issue/pr deals with documentation (errors) labels Sep 8, 2021
@openssl-machine openssl-machine added approval: ready to merge The 24 hour grace period has passed, ready to merge and removed approval: done This pull request has the required number of approvals labels Sep 9, 2021
@openssl-machine
Copy link
Collaborator

This pull request is ready to merge

openssl-machine pushed a commit that referenced this pull request Sep 9, 2021
CLA: trivial

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #16553)
openssl-machine pushed a commit that referenced this pull request Sep 9, 2021
CLA: trivial

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #16553)

(cherry picked from commit 5ecf10a)
@t8m
Copy link
Member

t8m commented Sep 9, 2021

Merged to master and 3.0 branches. Thank you for your contribution.

@t8m t8m closed this Sep 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approval: ready to merge The 24 hour grace period has passed, ready to merge branch: master Merge to master branch branch: 3.0 Merge to openssl-3.0 branch cla: trivial One of the commits is marked as 'CLA: trivial' triaged: documentation The issue/pr deals with documentation (errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants