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

Document crypto.timingSafeEqual() added in v6.6.0 #8796

Closed
wants to merge 1 commit into from
Closed

Document crypto.timingSafeEqual() added in v6.6.0 #8796

wants to merge 1 commit into from

Conversation

madarche
Copy link
Contributor

@madarche madarche commented Sep 26, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Document that the method crypto.timingSafeEqual() has been added in v6.6.0
cf. #8304

@nodejs-github-bot nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Sep 26, 2016
Copy link
Member

@lpinca lpinca left a comment

Choose a reason for hiding this comment

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

LGTM

@lpinca
Copy link
Member

lpinca commented Sep 26, 2016

If you want, you can reduce the work needed to land this patch by updating the commit message as per https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit.

Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

LGTM, and +1 to @lpinca’s suggestion (although that is by no means a blocker for this).

@madarche
Copy link
Contributor Author

@lpinca, @addaleax : I had read the contribution guide. Thought that my initial commit message was enough. Have amended the commit message for it to be more thorough. Hope it's OK now.

@lpinca
Copy link
Member

lpinca commented Sep 26, 2016

@madarche it should include the subsystem and should be 50 chars or less in total. Can I suggest "doc: add added: info for crypto.timingSafeEqual()"?
Feel free to update it.

crypto.timingSafeEqual() has been added in v6.6.0 cf. #8304

This commit adds the metadata that will display
"Added in: v6.6.0" and that can later be checked on
https://nodejs.org/api/crypto.html#crypto_crypto_timingsafeequal_a_b
@madarche
Copy link
Contributor Author

@lpinca: Hopefully fixed. Thanks. Didn't think the "subsystem" applied to doc as well

@lpinca
Copy link
Member

lpinca commented Sep 26, 2016

Thank you.

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

LGTM

jasnell pushed a commit that referenced this pull request Sep 27, 2016
crypto.timingSafeEqual() has been added in v6.6.0 cf. #8304

This commit adds the metadata that will display
"Added in: v6.6.0" and that can later be checked on
https://nodejs.org/api/crypto.html#crypto_crypto_timingsafeequal_a_b

PR-URL: #8796
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@jasnell
Copy link
Member

jasnell commented Sep 27, 2016

Landed in bb78f65. Thank you!

@jasnell jasnell closed this Sep 27, 2016
jasnell pushed a commit that referenced this pull request Sep 29, 2016
crypto.timingSafeEqual() has been added in v6.6.0 cf. #8304

This commit adds the metadata that will display
"Added in: v6.6.0" and that can later be checked on
https://nodejs.org/api/crypto.html#crypto_crypto_timingsafeequal_a_b

PR-URL: #8796
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Fishrock123 pushed a commit that referenced this pull request Oct 11, 2016
crypto.timingSafeEqual() has been added in v6.6.0 cf. #8304

This commit adds the metadata that will display
"Added in: v6.6.0" and that can later be checked on
https://nodejs.org/api/crypto.html#crypto_crypto_timingsafeequal_a_b

PR-URL: #8796
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants