-
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
Correct typos #11189
Correct typos #11189
Conversation
bf4
commented
Feb 6, 2017
IMO this is not very good idea. Changes a bunch of comments, variable names, mostly in deps. At the very least you should exclude deps |
Agreed. If you leave out the changes in |
I agree we should exclude deps/, but I think we should also more generally exclude any dependencies, no matter where they are located. That includes deps/ as well as various third-party dependencies in tools/ (e.g. tools/eslint and tools/gyp) for example. |
@cjihrig @vkurchatkin Sure, will update |
@mscdex @cjihrig @vkurchatkin Updated. Think I got the right surface area here? I removed any node_modules as well. (Of course I'll rebase) |
@bf4 I think the tools/eslint, tools/gyp, and tools/icu changes should be reverted as well as those changes are all to upstream files. |
@mscdex Added another commit removing anything from tools for ease of review |
src/node_lttng_provider.h
Outdated
@@ -78,7 +78,7 @@ void NODE_GC_START(v8::GCType type, | |||
void NODE_GC_DONE(v8::GCType type, | |||
v8::GCCallbackFlags flags, | |||
v8::Isolate* isolate) { | |||
const char* typeStr = "Unkown GC Type"; | |||
const char* typeStr = "Unknown GC Type"; |
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.
@nodejs/ctc Does this constitute a semver-major change?
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.
funny what spell checkers find :) would this be considered a public API...
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.
Well it's a tracing mechanism, which may/may not be considered part of the "runtime." That's why I'd like to get some feedback to see where this kind of change would fall since AFAIK error string changes in general are still semver-major changes.
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.
@nodejs/ctc What do you think about this error message change as far as semver-ness goes?
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.
If this is an officially supported feature, then semver major. Honestly, version 8 is coming up soon, so maybe just make it semver major anyway.
doc/changelogs/CHANGELOG_V6.md
Outdated
@@ -1362,7 +1362,7 @@ Semver Patch: | |||
* [[`abf86adee1`](https://github.com/nodejs/node/commit/abf86adee1)] - **deps**: back-port d721121 from v8 upstream (Ben Noordhuis) [#7633](https://github.com/nodejs/node/pull/7633) | |||
* [[`dbdcded866`](https://github.com/nodejs/node/commit/dbdcded866)] - **deps**: upgrade to V8 5.0.71.54 (Ben Noordhuis) [#7531](https://github.com/nodejs/node/pull/7531) | |||
* [[`4839ef37a9`](https://github.com/nodejs/node/commit/4839ef37a9)] - **doc**: correcting misspelling (Vitaly Tomilov) [#7797](https://github.com/nodejs/node/pull/7797) | |||
* [[`3343d46f2c`](https://github.com/nodejs/node/commit/3343d46f2c)] - **doc**: general improvments to events documentation (Sakthipriyan Vairamani) [#7480](https://github.com/nodejs/node/pull/7480) | |||
* [[`3343d46f2c`](https://github.com/nodejs/node/commit/3343d46f2c)] - **doc**: general improvements to events documentation (Sakthipriyan Vairamani) [#7480](https://github.com/nodejs/node/pull/7480) |
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.
I'm not sure this change should be kept, it's referencing a commit message which would still have the original misspelling and that might cause confusion.
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.
I agree, let's not fix the commit messages in changelogs.
doc/changelogs/CHANGELOG_V4.md
Outdated
@@ -813,7 +813,7 @@ Semver Patch: | |||
* [[`1e86d16812`](https://github.com/nodejs/node/commit/1e86d16812)] - **doc**: buffers are not sent over IPC with a socket (Tim Kuijsten) [#6951](https://github.com/nodejs/node/pull/6951) | |||
* [[`5c1d8e1f0f`](https://github.com/nodejs/node/commit/5c1d8e1f0f)] - **doc**: add `added:` information for http (Anna Henningsen) [#7392](https://github.com/nodejs/node/pull/7392) | |||
* [[`60c054bc11`](https://github.com/nodejs/node/commit/60c054bc11)] - **doc**: add information for IncomingMessage.destroy() (Rich Trott) [#7237](https://github.com/nodejs/node/pull/7237) | |||
* [[`1a5c025f32`](https://github.com/nodejs/node/commit/1a5c025f32)] - **doc**: remove superfluos backticks in process.md (Anna Henningsen) [#7681](https://github.com/nodejs/node/pull/7681) | |||
* [[`1a5c025f32`](https://github.com/nodejs/node/commit/1a5c025f32)] - **doc**: remove superfluous backticks in process.md (Anna Henningsen) [#7681](https://github.com/nodejs/node/pull/7681) |
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.
Ditto about all of these changes to commit messages in the changelogs.
@@ -215,7 +215,7 @@ This is a security release. All Node.js users should consult the security releas | |||
### Notable changes | |||
|
|||
**http**: | |||
* Enclose IPv6 Host header in square brackets. This will enable proper separation of the host adress from any port reference (Mihai Potra) [#5314](https://github.com/nodejs/node/pull/5314) | |||
* Enclose IPv6 Host header in square brackets. This will enable proper separation of the host address from any port reference (Mihai Potra) [#5314](https://github.com/nodejs/node/pull/5314) |
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.
This change should be fine I think since it was actually spelled correctly in the relevant commit message.
A few nits and a question, otherwise the rest LGTM though. |
@mscdex Thanks for your review. I'll wait on getting confirmation of how to handle the changelogs before making more changes, then I'll push changes and squash down to one commit. |
@mscdex @thefourtheye should I wait for any more comments before updating? |
@bf4 Feel free to update, we're just waiting on more input from other collaborators on the change in the one error message string. |
@mscdex @cjihrig I've updated the PR to add --- a/src/node_lttng_provider.h
+++ b/src/node_lttng_provider.h
@@ -61,7 +61,7 @@ void NODE_NET_STREAM_END(node_lttng_connection_t* conn,
void NODE_GC_START(v8::GCType type,
v8::GCCallbackFlags flags,
v8::Isolate* isolate) {
- const char* typeStr = "Unknown GC Type";
+ const char* typeStr = "Unkown GC Type"; // [sic]
const char* flagsStr = "Unknown GC Flag";
#define BUILD_IF(f) if (type == v8::GCType::f) { typeStr = #f; }
@@ -78,7 +78,7 @@ void NODE_GC_START(v8::GCType type,
void NODE_GC_DONE(v8::GCType type,
v8::GCCallbackFlags flags,
v8::Isolate* isolate) {
- const char* typeStr = "Unknown GC Type";
+ const char* typeStr = "Unkown GC Type"; // [sic]
const char* flagsStr = "Unknown GC Flag"; |
774efc1
to
c1cea32
Compare
@bf4 There's a typo in node.cc that you might want to include (s/enought/enough/). |
@mscdex Pushed. would you like me to rebase and squash down to one commit? |
@bf4 Nah, that can be done when landing. I plan on landing this tonight if nobody else beats me to 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
@jasnell If I'm reading that correctly, there's a conflict from an earlier commit in the PR? |
doc/changelogs/CHANGELOG_IOJS.md
Outdated
@@ -2207,7 +2207,7 @@ _Note: version **1.4.0** was tagged and built but not released. A libuv bug was | |||
* [[`3b1b4de903`](https://github.com/nodejs/node/commit/3b1b4de903)] - **test**: Timeout#unref() does not return instance (Jan Schär) [joyent/node#9171](https://github.com/joyent/node/pull/9171) | |||
* [[`becb4e980e`](https://github.com/nodejs/node/commit/becb4e980e)] - **test**: distribute crypto tests into separate files (Brendan Ashworth) [#827](https://github.com/nodejs/node/pull/827) | |||
* [[`77f35861d0`](https://github.com/nodejs/node/commit/77f35861d0)] - **(SEMVER-MINOR) tls**: more secure defaults (Roman Reiss) [#826](https://github.com/nodejs/node/pull/826) | |||
* [[`faa687b4be`](https://github.com/nodejs/node/commit/faa687b4be)] - **url**: reslove urls with . and .. (Amir Saboury) [#278](https://github.com/nodejs/node/pull/278) | |||
* [[`faa687b4be`](https://github.com/nodejs/node/commit/faa687b4be)] - **url**: reslove [sic] urls with . and .. (Amir Saboury) [#278](https://github.com/nodejs/node/pull/278) |
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.
I'm not sure if adding '[sic]' helps in the commit messages in changelogs since the way the commits are laid out it could be seen as being part of the literal commit message.
@bf4 It looks like the linter is complaining. |
doc/changelogs/CHANGELOG_IOJS.md
Outdated
@@ -2494,7 +2494,7 @@ _Note: version **1.4.0** was tagged and built but not released. A libuv bug was | |||
* [[`b7365c1`](https://github.com/nodejs/node/commit/b7365c15597253e906590045aa6f3f07f6e76b52)] - repl: make REPL support multiline template literals (Xiaowei Li) | |||
* [[`2253d30`](https://github.com/nodejs/node/commit/2253d30d9cbba42abc1faa183e4480cac69c4222)] - build: remove unused variable (Johan Bergström) | |||
* [[`ab04a43`](https://github.com/nodejs/node/commit/ab04a434761cf66d107481d58798f36d3cb49d46)] - doc: add optional sudo to make install in README (Glen Keane) | |||
* [[`1b1cd1c`](https://github.com/nodejs/node/commit/1b1cd1c3f8e21b34a8e1355e545057a661acaa15)] - build: shorten configurate script print on stdout (Roman Reiss) | |||
* [[`1b1cd1c`](https://github.com/nodejs/node/commit/1b1cd1c3f8e21b34a8e1355e545057a661acaa15)] - build: shorten configurate [sic] script print on stdout (Roman Reiss) |
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.
This one should probably be removed also.
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.
oops, that's embarassing
0f8ebaa
to
8b90964
Compare
I'm finding it unusually difficult to find the actual failure in the CI logs. |
``` go get -u github.com/client9/misspell/cmd/misspell misspell -w -error -source=text . ```
8b90964
to
1b4a66b
Compare
I rebased off of master to adjust for the conflicting file that was moved 3c92200 |
@bf4 There weren't any failures in the last CI run. However, here is another run with your recent change: https://ci.nodejs.org/job/node-test-pull-request/6632/ |
@@ -238,7 +238,7 @@ inline const void* MemrchrFill(const void* haystack, uint8_t needle, | |||
} | |||
|
|||
|
|||
// Finds the first occurence of *two-byte* character pattern[0] in the string | |||
// Finds the first occurrence of *two-byte* character pattern[0] in the string |
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.
I think this file comes from deps/v8/src/string-search.h with the typo ?
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.
That's ok.
@mscdex I don't see how those failure could be related to this PR When I drill down https://ci.nodejs.org/job/node-test-binary-windows/6806/RUN_SUBSET=1,VS_VERSION=vs2015,label=win2008r2/tapResults/ relates to a file
and the other https://ci.nodejs.org/job/node-test-commit-arm/8016/nodes=armv8-ubuntu1404/console relates to a failure to publish TAP results
I do wonder if |
@bf4 You're correct, they're unrelated. The changes should be good to go now. |
Lemme know if there's anything else for me to do. |
Landed in 4897ae2. Thanks! |
PR-URL: #11189 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
PR-URL: #11189 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Is a semver-breaking change Refs: nodejs#11189 (comment)
Is a semver-breaking change Refs: #11189 (comment) PR-URL: #11723 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Is a semver-breaking change Refs: nodejs#11189 (comment) PR-URL: nodejs#11723 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace the backport request label with do-not-land if it shouldn't land |