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

doc: Improve checkServerIdentity docs #17203

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
9 participants
@Hannes-Magnusson-CK
Contributor

Hannes-Magnusson-CK commented Nov 21, 2017

Checklist
Affected core subsystem(s)

tls doc

@Hannes-Magnusson-CK

This comment has been minimized.

Show comment
Hide comment
@Hannes-Magnusson-CK

Hannes-Magnusson-CK Nov 21, 2017

Contributor

See also #11467

Contributor

Hannes-Magnusson-CK commented Nov 21, 2017

See also #11467

@Trott

Seems good to me with one requested change. Thanks for the pull request!

Show outdated Hide outdated doc/api/tls.md Outdated
@lpinca

lpinca approved these changes Nov 22, 2017

Show outdated Hide outdated doc/api/tls.md Outdated
@Hannes-Magnusson-CK

This comment has been minimized.

Show comment
Hide comment
@Hannes-Magnusson-CK

Hannes-Magnusson-CK Nov 22, 2017

Contributor

Probably a dumb question, I'm new around here =):
The "Public API" comment in https://github.com/nodejs/node/blob/master/lib/tls.js#L239

What makes those export more public then say https://github.com/nodejs/node/blob/master/lib/tls.js#L168 ?

If thats purely source code readability, should I document the checkServerIdentity function?

Contributor

Hannes-Magnusson-CK commented Nov 22, 2017

Probably a dumb question, I'm new around here =):
The "Public API" comment in https://github.com/nodejs/node/blob/master/lib/tls.js#L239

What makes those export more public then say https://github.com/nodejs/node/blob/master/lib/tls.js#L168 ?

If thats purely source code readability, should I document the checkServerIdentity function?

@bnoordhuis

This comment has been minimized.

Show comment
Hide comment
@bnoordhuis

bnoordhuis Nov 22, 2017

Member

@Hannes-Magnusson-CK The comment is a bit misguided / misleading, it should just be removed.

You could read it as "these are the public and documented APIs" but some of the exports elsewhere are mentioned in the docs too, if only in passing.

Member

bnoordhuis commented Nov 22, 2017

@Hannes-Magnusson-CK The comment is a bit misguided / misleading, it should just be removed.

You could read it as "these are the public and documented APIs" but some of the exports elsewhere are mentioned in the docs too, if only in passing.

@Hannes-Magnusson-CK

This comment has been minimized.

Show comment
Hide comment
@Hannes-Magnusson-CK

Hannes-Magnusson-CK Nov 22, 2017

Contributor

Ok. Thanks @bnoordhuis !
I'll see if I can create another PR for documenting the checkServerIdentity function, removing the comment, and maybe couple of other related things.

Contributor

Hannes-Magnusson-CK commented Nov 22, 2017

Ok. Thanks @bnoordhuis !
I'll see if I can create another PR for documenting the checkServerIdentity function, removing the comment, and maybe couple of other related things.

@Hannes-Magnusson-CK

This comment has been minimized.

Show comment
Hide comment
@Hannes-Magnusson-CK

Hannes-Magnusson-CK Nov 22, 2017

Contributor

Added a commit documenting tls.checkServerIdentity to this PR :)

Contributor

Hannes-Magnusson-CK commented Nov 22, 2017

Added a commit documenting tls.checkServerIdentity to this PR :)

@@ -236,7 +236,6 @@ exports.parseCertString = internalUtil.deprecate(
'Please use querystring.parse() instead.',
'DEP0076');
// Public API

This comment has been minimized.

@jasnell

jasnell Nov 22, 2017

Member

why remove this?

@jasnell

jasnell Nov 22, 2017

Member

why remove this?

This comment has been minimized.

@Hannes-Magnusson-CK

Hannes-Magnusson-CK Nov 22, 2017

Contributor

Its a misleading comment. These aren't the only exported functions.

@Hannes-Magnusson-CK

Hannes-Magnusson-CK Nov 22, 2017

Contributor

Its a misleading comment. These aren't the only exported functions.

@Trott Trott dismissed their stale review Nov 24, 2017

requested change was made

@addaleax

This comment has been minimized.

Show comment
Hide comment
@addaleax

addaleax Dec 1, 2017

Member

Landed in da429c3, df63e53

Thanks for the PR! 🎉

Member

addaleax commented Dec 1, 2017

Landed in da429c3, df63e53

Thanks for the PR! 🎉

@addaleax addaleax closed this Dec 1, 2017

addaleax added a commit that referenced this pull request Dec 1, 2017

doc: improve checkServerIdentity docs
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

addaleax added a commit that referenced this pull request Dec 1, 2017

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@addaleax addaleax removed the author ready label Dec 1, 2017

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: improve checkServerIdentity docs
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: improve checkServerIdentity docs
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@MylesBorins MylesBorins referenced this pull request Dec 12, 2017

Merged

v9.3.0 proposal #17631

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: improve checkServerIdentity docs
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: improve checkServerIdentity docs
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@gibfahn

This comment has been minimized.

Show comment
Hide comment
@gibfahn

gibfahn Dec 19, 2017

Member

Backported da429c3 to v6.x, df63e53 had conflicts, so choosing to leave it.

Member

gibfahn commented Dec 19, 2017

Backported da429c3 to v6.x, df63e53 had conflicts, so choosing to leave it.

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Closed

v8.9.4 proposal #17772

gibfahn added a commit that referenced this pull request Dec 20, 2017

doc: improve checkServerIdentity docs
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gibfahn added a commit that referenced this pull request Dec 20, 2017

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Merged

v8.9.4 proposal #17774

@MylesBorins MylesBorins referenced this pull request Dec 20, 2017

Merged

v6.12.3 proposal #17776

msoechting added a commit to hpicgs/node that referenced this pull request Feb 5, 2018

doc: improve checkServerIdentity docs
PR-URL: nodejs#17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 5, 2018

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: nodejs#17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: improve checkServerIdentity docs
PR-URL: nodejs#17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: document tls.checkServerIdentity
The funciton was added in eb2ca10

PR-URL: nodejs#17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@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