-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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: value choice for imitating the old behavior of http.Server.keepAliveTimeout #17660
doc: value choice for imitating the old behavior of http.Server.keepAliveTimeout #17660
Conversation
doc/api/http.md
Outdated
@@ -919,6 +919,8 @@ timeout has fired, it will reset the regular inactivity timeout, i.e., | |||
[`server.timeout`][]. | |||
|
|||
A value of 0 will disable the keep-alive timeout behavior on incoming connections. | |||
A value of 0 makes the http server behaves similarly to earlier nodejs versions, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please change behaves
to behave
and nodejs
to Node.js
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, while we're in here, it would be good to put backticks around 0
so it's `0`
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, @TysonAndre! Welcome and thanks for the pull request. I have no opinion on whether the actual change should go through or not--it's not clear to me that catering to people looking to emulate old versions is good for the documentation. But if it does go through, there are some grammar/style corrections that will need to happen. I've left a pair of comments. Please take a look. Thanks again!
…liveTimeout Documenting the best way to imitate the old behavior saves time for people migrating from older versions. (E.g. for unexpected ECONNRESET) It isn't immediately obvious if earlier nodejs versions behaved the same way as nodejs 8 does with keepAliveTimeout = 0. From 0aa7ef5, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making the change additive like this is 👍 by me. Optional improvement: Might be good to include the exact version in which it changed. So instead of earlier Node.js versions
it could be Node.js versions prior to 8.0.0
or whatever the right version number is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM if @apapirovski is happy with it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM from a technical perspective. Maybe not having the "A value of 0
" repeat would be possible but that can be adjusted in a different PR if someone feels passionate enough about it.
Documenting the best way to imitate the old behavior saves time for people migrating from older versions. (E.g. for unexpected ECONNRESET) It isn't immediately obvious if earlier nodejs versions behaved the same way as nodejs 8 does with keepAliveTimeout = 0. From 0aa7ef5, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8 PR-URL: #17660 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
Landed in 214bbb5 |
Documenting the best way to imitate the old behavior saves time for people migrating from older versions. (E.g. for unexpected ECONNRESET) It isn't immediately obvious if earlier nodejs versions behaved the same way as nodejs 8 does with keepAliveTimeout = 0. From 0aa7ef5, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8 PR-URL: #17660 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
Documenting the best way to imitate the old behavior saves time for people migrating from older versions. (E.g. for unexpected ECONNRESET) It isn't immediately obvious if earlier nodejs versions behaved the same way as nodejs 8 does with keepAliveTimeout = 0. From 0aa7ef5, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8 PR-URL: #17660 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
Documenting the best way to imitate the old behavior saves time for people migrating from older versions. (E.g. for unexpected ECONNRESET) It isn't immediately obvious if earlier nodejs versions behaved the same way as nodejs 8 does with keepAliveTimeout = 0. From 0aa7ef5, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8 PR-URL: #17660 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
Documenting the best way to imitate the old behavior saves time for people migrating from older versions. (E.g. for unexpected ECONNRESET) It isn't immediately obvious if earlier nodejs versions behaved the same way as nodejs 8 does with keepAliveTimeout = 0. From 0aa7ef5, it seems like they behave the same way. Related to issues such as #13391 that show up when migrating to node 8 PR-URL: #17660 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
Checklist
Documenting the best way to imitate the old behavior saves time for people
migrating from older versions.
(E.g. for unexpected ECONNRESET)
It isn't immediately obvious if earlier nodejs versions behaved the same
way as nodejs 8 does with keepAliveTimeout = 0.
From 0aa7ef5, it seems like they behave
the same way.
Related to issues such as #13391 that show up when migrating to node 8
Affected core subsystem(s)
doc