BackPup/node
1
0 Fork 0
mirror of https://github.com/nodejs/node.git synced 2026-10-14 10:26:26 -04:00
Code Issues Packages Projects Releases Wiki Activity
32,284 Commits 236 Branches 964 Tags
2425589262fbe8c05caead80653e02a707bc4b4e
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Rich Trott 2425589262 doc: fix punctuation in v8.md 
Two minor punctuation fixes for v8.md.

PR-URL: https://github.com/nodejs/node/pull/36192
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
 2020-11-20 20:59:53 +00:00
Rich Trott 6312193391 tools: bump unist-util-find@1.0.1 to unist-util-find@1.0.2 
PR-URL: https://github.com/nodejs/node/pull/36106
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-11-20 04:55:54 -08:00
Rich Trott 5a8a59e3b9 doc: add link for v8.takeCoverage() 
PR-URL: https://github.com/nodejs/node/pull/36135
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
 2020-11-19 04:31:36 -08:00
Rich Trott 8938d37251 doc: clarify text about process not responding 
The existing text about processes not responding is unclear, at least to
me. Suggestions for clarification welcome, but I think the best thing
might be to state that the process may stop responding and leave it at
that. The explanantion (about asynchronous listeners) is not clear to
me. (Why would the fact that the listeners are asynchronous matter?) If
it's an unnecessary detail (as seems likely), let's remove it.

PR-URL: https://github.com/nodejs/node/pull/36117
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-11-18 04:17:31 -08:00
Rich Trott fff25a0714 test: make test-http2-client-jsstream-destroy.js reliable 
Use events instead of setTimeout() calls.

Fixes: https://github.com/nodejs/node/issues/36078

PR-URL: https://github.com/nodejs/node/pull/36129
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
 2020-11-17 08:28:20 -08:00
Rich Trott 52666aa801 doc: fix invalid link in worker_threads.md 
Inadvertent double hash in link makes it invalid and no longer pointing
to the documentation section it intends to point to.

PR-URL: https://github.com/nodejs/node/pull/36109
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-11-15 06:20:20 -08:00
Rich Trott 55d810f8df doc: move shigeki to emeritus 
In email, Shigeki Ohtsu indicated that a move to emeritus would be
appropriate at this time. I'm especially grateful for the crypto and
security work over the years, and I'm sure I'm not the only one.

PR-URL: https://github.com/nodejs/node/pull/36093
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-11-15 06:07:17 -08:00
Rich Trott 382ed92fa8 test: add util.inspect test for null maxStringLength 
Add test case to cover currently-uncovered code.

Refs: https://coverage.nodejs.org/coverage-39a7f7663e8f70fc/lib/internal/util/inspect.js.html#L333

PR-URL: https://github.com/nodejs/node/pull/36086
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-11-14 05:25:24 -08:00
Rich Trott bd8fc67f6a doc: fix typo in debugger.md 
Use apostrophe for possessive.

PR-URL: https://github.com/nodejs/node/pull/36066
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
 2020-11-13 06:02:16 -08:00
Rich Trott f03f7cbd35 test: fix unreliable test-fs-write-file.js 
The test uses a file name twice, causing unreliability in CI. In
particular, it's failing a lot on the Raspberry Pi devices.

Fixes: https://github.com/nodejs/node/issues/36090

PR-URL: https://github.com/nodejs/node/pull/36102
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
 2020-11-12 15:08:10 -08:00
Rich Trott 660265e108 test: move test-worker-eventlooputil to sequential 
The test is not nearly as unreliable as it used to be but we're still
seeing failures around the timing checks that will definitely be
affected by other tests running in other processes. So move it to
sequential.

Refs: https://github.com/nodejs/node/pull/35961#issuecomment-722222696

PR-URL: https://github.com/nodejs/node/pull/35996
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-11-12 20:26:49 +00:00
Rich Trott 55b1718b6a test: remove flaky designation for fixed test 
Remove flaky designation for test-worker-eventlooputil fixed in 9dbde1d.

PR-URL: https://github.com/nodejs/node/pull/35961
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-11-12 05:34:36 -08:00
Rich Trott 088af0f98b tools: update doc tools to remark-parse@9.0.0 
PR-URL: https://github.com/nodejs/node/pull/36049
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-11-12 06:29:51 +00:00
Rich Trott a783f9bc22 doc: update list styles for remark-parse@9 rendering 
remark-parse@9.0.0 combined with our html.js tool ends a list if a
multi-line item does not include indentation. Update our docs for this
formatting.

I looked around for a lint rule to enforce this but didn't find one
readily available. (Happy to be shown that I'm wrong about that!) We may
need to write one.

PR-URL: https://github.com/nodejs/node/pull/36049
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-11-12 06:29:49 +00:00
Rich Trott e53f232291 test: add missing test coverage for setLocalAddress() 
Add missing coverage for setLocalAddress() method of dns.Resolver class.
The case where a valid IPv4 argument was supplied along with an invalid
IPv6 argument was not being checked.

Refs: https://coverage.nodejs.org/coverage-85b42af4398073f8/lib/internal/dns/utils.js.html#L124

PR-URL: https://github.com/nodejs/node/pull/36039
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
 2020-11-11 05:10:56 -08:00
Rich Trott 270a02c38f doc: move v8.getHeapCodeStatistics() 
Move v8.getHeapCodeStatistics() to its alphabetic location in the docs.
An effort to alphabetize all the entries met some resistance on the
grounds that it put some things in an order that wasn't logical, but
this one should be uncontroversial, I think.

PR-URL: https://github.com/nodejs/node/pull/36027
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
 2020-11-10 05:29:19 -08:00
Rich Trott 642174a31f dns: fix trace_events name for resolveCaa() 
A test was added for this in 6f34498 but because it was a test in the
`internet` directory, it was not run on CI and it was not noticed that
the test was failing. This fixes the error that was causing the test to
fail.

PR-URL: https://github.com/nodejs/node/pull/35979
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
 2020-11-09 05:57:00 -08:00
Rich Trott 1d525f55bc fs: remove unused assignment 
PR-URL: https://github.com/nodejs/node/pull/35882
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-11-06 21:59:29 -08:00
Rich Trott ec400f8056 doc: revise v8.getHeapSnapshot() 
* move entry above v8.getHeapSpaceStatistics() (where it belongs
  alphabetically and is not out of place logically)
* split lengthy sentence into two sentences

PR-URL: https://github.com/nodejs/node/pull/35849
Reviewed-By: Michael Dawson <midawson@redhat.com>
 2020-11-06 04:59:31 -08:00
Rich Trott c575aec2a7 doc: update benchmark CI test indicator in README 
As of c7627da837, benchmark tests are run
in CI, but the README was not updated to indicate this.

PR-URL: https://github.com/nodejs/node/pull/35945
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-11-05 05:52:42 -08:00
Rich Trott 088dfce777 test: fix error in test/internet/test-dns.js 
Refs: https://github.com/nodejs/node/pull/35466#issuecomment-721936009

PR-URL: https://github.com/nodejs/node/pull/35969
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-11-05 05:50:20 -08:00
Rich Trott 72ce5dcd52 test: add missing ref comments to parallel.status 
PR-URL: https://github.com/nodejs/node/pull/35896
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-11-04 04:56:52 -08:00
Rich Trott 1bc1f847ca tools: bump remark-lint-preset-node to 2.0.0 
Update remark@13.0.0, remark-lint-preset-node@2.0.0 and other
dependencies in the lint-md rollup.

PR-URL: https://github.com/nodejs/node/pull/35905
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
 2020-11-03 05:18:09 -08:00
Rich Trott adfcaded3c doc: update tables in README files for linting changes 
PR-URL: https://github.com/nodejs/node/pull/35905
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
 2020-11-03 05:18:07 -08:00
Rich Trott b600b9a903 tools: refloat 7 Node.js patches to cpplint.py 
Cherry-pick 12c8b4d154
Original commit message:
    This commit is a suggestion for adding a rule for NULL usages in the
    code base. This will currently report a number of errors which could be
    ignored using // NOLINT (readability/null_usage)

    PR-URL: https://github.com/nodejs/node/pull/17373
    Reviewed-By: Jon Moss <me@jonathanmoss.me>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
    Reviewed-By: Timothy Gu <timothygu99@gmail.com>
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
    Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
    Reviewed-By: Tobias Nießen <tniessen@tnie.de>

Refs: https://github.com/nodejs/node/commit/12c8b4d15471cb6211b39c3a2ca5b10fa4b9f12b

Cherry-pick fc81e80191
Original commit message:

    Update cpplint.py to check for inline headers when the corresponding
    header is already included.

    PR-URL: https://github.com/nodejs/node/pull/21521
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: https://github.com/nodejs/node/commit/fc81e801913de3e3f3c0c8e26c105f983a74e539

Cherry-pick cbc3dd997e
Original commit message:

    src, tools: add check for left leaning pointers

    This commit adds a rule to cpplint to check that pointers in the code
    base lean to the left and not right, and also fixes the violations
    reported.

    PR-URL: https://github.com/nodejs/node/pull/21010
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
    Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: https://github.com/nodejs/node/commit/cbc3dd997eb90d629d1b9912b7a5a40eb82343df

Cherry-pick 902998190a
Original commit message:

    tools: fix cpplint.py header rules

    THIS COMMIT SHOULD GO WITH THE NEXT. IT WILL FIND NEW LINT.

    PR-URL: https://github.com/nodejs/node/pull/26306
    Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Refs: https://github.com/nodejs/node/commit/902998190a55d6915b881936f6dd5b6e9cca6ad8

Cherry-pick 0a25ace9c3
Original commit message:

    tools: move cpplint configuration to .cpplint

    PR-URL: https://github.com/nodejs/node/pull/27098
    Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
    Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refs: https://github.com/nodejs/node/commit/0a25ace9c35b62ece4d32fd90b326d8063265109

Cherry-pick afa9a7206c
Original commit message:

    tools: refloat update link to google styleguide for cpplint

    This commit updates two old links to Google's C++ styleguide which
    currently result in a 404 when accessed.

    PR-URL: https://github.com/nodejs/node/pull/30876
    Reviewed-By: Michaël Zasso <targos@protonmail.com>
    Reviewed-By: David Carlier <devnexen@gmail.com>
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Richard Lau <riclau@uk.ibm.com>
    Reviewed-By: Rich Trott <rtrott@gmail.com>

Refs: https://github.com/nodejs/node/commit/afa9a7206c26a29a2af226696c145c924a6d3754

Cherry-pick e23bf8f771
Original commit message:

    tools,src: refloat forbid usage of v8::Persistent

    `v8::Persistent` comes with the surprising catch that it requires
    manual cleanup. `v8::Global` doesn’t, making it easier to use,
    and additionally provides move semantics. New code should always
    use `v8::Global`.

    PR-URL: https://github.com/nodejs/node/pull/31018
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Richard Lau <riclau@uk.ibm.com>
    Reviewed-By: James M Snell <jasnell@gmail.com>
    Reviewed-By: David Carlier <devnexen@gmail.com>
    Reviewed-By: Rich Trott <rtrott@gmail.com>
    Reviewed-By: Gus Caplan <me@gus.host>
    Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>

PR-URL: https://github.com/nodejs/node/pull/35569
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/35719
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/35866
 2020-11-02 08:03:44 -08:00
Rich Trott c61306df36 tools: bump cpplint to 1.5.1 
https://github.com/cpplint/cpplint/releases/tag/1.5.1

PR-URL: https://github.com/nodejs/node/pull/35866
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
 2020-11-02 08:03:41 -08:00
Rich Trott dc9f108c5c doc: move ronkorving to emeritus 
In email, ronkorving indicated that he could/should be moved to emeritus
at this time.

PR-URL: https://github.com/nodejs/node/pull/35828
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
 2020-10-30 06:15:00 -07:00
Rich Trott 937b70ddec doc: make small improvements to REPL doc 
* button -> key
* apply missing kbd element
* revise "Recoverable errors" text for brevity and clarity

PR-URL: https://github.com/nodejs/node/pull/35808
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-10-28 06:29:39 -07:00
Rich Trott 245ec6f5ab doc,test: update v8 method doc and comment 
Update documentation and test comment for v8.cachedDataVersionTag().

PR-URL: https://github.com/nodejs/node/pull/35795
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
 2020-10-27 06:18:26 -07:00
Rich Trott 34810e0141 doc: consolidate and clarify breakOnSigInt text 
PR-URL: https://github.com/nodejs/node/pull/35787
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-27 11:34:16 +00:00
Rich Trott dd43715caa doc: use kbd element in readline doc prose 
The kbd element has already been added in the keybindings table, but we
missed it in one line in the prose.

PR-URL: https://github.com/nodejs/node/pull/35737
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
 2020-10-26 03:33:34 -07:00
Rich Trott e54c8b788d doc: remove stability warning in v8 module doc 
Remove note indicating that the APIs can change at any time. This module
migrated from Experimental to Stable 6 years ago (in io.js 1.4.2).

PR-URL: https://github.com/nodejs/node/pull/35774
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-10-25 05:43:46 -07:00
Rich Trott 6bf2139365 doc: improve text for breakOnSigint 
* Make the 7 instances of breakOnSigint text blocks consistent.
* Use present tense.
* Use kbd element for keystrokes.
* Minor style edits.

PR-URL: https://github.com/nodejs/node/pull/35692
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-10-24 05:15:05 -07:00
Rich Trott d233f10f03 tools: refloat 7 Node.js patches to cpplint.py 
Cherry-pick 12c8b4d154
Original commit message:
    This commit is a suggestion for adding a rule for NULL usages in the
    code base. This will currently report a number of errors which could be
    ignored using // NOLINT (readability/null_usage)

    PR-URL: https://github.com/nodejs/node/pull/17373
    Reviewed-By: Jon Moss <me@jonathanmoss.me>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
    Reviewed-By: Timothy Gu <timothygu99@gmail.com>
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
    Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
    Reviewed-By: Tobias Nießen <tniessen@tnie.de>

Refs: https://github.com/nodejs/node/commit/12c8b4d15471cb6211b39c3a2ca5b10fa4b9f12b

Cherry-pick fc81e80191
Original commit message:

    Update cpplint.py to check for inline headers when the corresponding
    header is already included.

    PR-URL: https://github.com/nodejs/node/pull/21521
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: https://github.com/nodejs/node/commit/fc81e801913de3e3f3c0c8e26c105f983a74e539

Cherry-pick cbc3dd997e
Original commit message:

    src, tools: add check for left leaning pointers

    This commit adds a rule to cpplint to check that pointers in the code
    base lean to the left and not right, and also fixes the violations
    reported.

    PR-URL: https://github.com/nodejs/node/pull/21010
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
    Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: https://github.com/nodejs/node/commit/cbc3dd997eb90d629d1b9912b7a5a40eb82343df

Cherry-pick 902998190a
Original commit message:

    tools: fix cpplint.py header rules

    THIS COMMIT SHOULD GO WITH THE NEXT. IT WILL FIND NEW LINT.

    PR-URL: https://github.com/nodejs/node/pull/26306
    Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Refs: https://github.com/nodejs/node/commit/902998190a55d6915b881936f6dd5b6e9cca6ad8

Cherry-pick 0a25ace9c3
Original commit message:

    tools: move cpplint configuration to .cpplint

    PR-URL: https://github.com/nodejs/node/pull/27098
    Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
    Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refs: https://github.com/nodejs/node/commit/0a25ace9c35b62ece4d32fd90b326d8063265109

Cherry-pick afa9a7206c
Original commit message:

    tools: refloat update link to google styleguide for cpplint

    This commit updates two old links to Google's C++ styleguide which
    currently result in a 404 when accessed.

    PR-URL: https://github.com/nodejs/node/pull/30876
    Reviewed-By: Michaël Zasso <targos@protonmail.com>
    Reviewed-By: David Carlier <devnexen@gmail.com>
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Richard Lau <riclau@uk.ibm.com>
    Reviewed-By: Rich Trott <rtrott@gmail.com>

Refs: https://github.com/nodejs/node/commit/afa9a7206c26a29a2af226696c145c924a6d3754

Cherry-pick e23bf8f771
Original commit message:

    tools,src: refloat forbid usage of v8::Persistent

    `v8::Persistent` comes with the surprising catch that it requires
    manual cleanup. `v8::Global` doesn’t, making it easier to use,
    and additionally provides move semantics. New code should always
    use `v8::Global`.

    PR-URL: https://github.com/nodejs/node/pull/31018
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Richard Lau <riclau@uk.ibm.com>
    Reviewed-By: James M Snell <jasnell@gmail.com>
    Reviewed-By: David Carlier <devnexen@gmail.com>
    Reviewed-By: Rich Trott <rtrott@gmail.com>
    Reviewed-By: Gus Caplan <me@gus.host>
    Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>

PR-URL: https://github.com/nodejs/node/pull/35569
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/35719
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-10-23 03:47:54 -07:00
Rich Trott d9ed73cf02 tools: bump cpplint to 1.5.0 
https://github.com/cpplint/cpplint/releases/tag/1.5.0

PR-URL: https://github.com/nodejs/node/pull/35719
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
 2020-10-23 03:47:52 -07:00
Rich Trott 4fb780334d doc,src,test: revise C++ code for linter update 
PR-URL: https://github.com/nodejs/node/pull/35719
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
 2020-10-23 03:47:50 -07:00
Rich Trott 6c4239bea7 doc: use kbd element in readline doc 
PR-URL: https://github.com/nodejs/node/pull/35698
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-10-21 04:44:36 -07:00
Rich Trott 3d9310d72b doc: use kbd element in os doc 
Use kbd element for key strokes and remove extra parentheses.

PR-URL: https://github.com/nodejs/node/pull/35656
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
 2020-10-20 04:45:52 -07:00
Rich Trott 1103b15af6 doc: fix YAML lint error on master 
Refs: https://github.com/nodejs/node/runs/1275049330

PR-URL: https://github.com/nodejs/node/pull/35709
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-10-19 05:54:15 -07:00
Rich Trott ce03a182cf doc: clarify experimental API elements in vm.md 
Remove redundant "should not be considered stable" (it immediately
follows a clause saying that it is "experimental") and replace with a
more clear (to me, at least) statement that we don't recommend using the
feature in production.

PR-URL: https://github.com/nodejs/node/pull/35594
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-19 04:48:35 -07:00
Rich Trott fbe33aa52e tools: bump remark-lint-preset-node to 1.17.1 
Bump remark-lint-preset-node@1.16.0 to remark-lint-preset-node@1.17.1.

Refs: https://github.com/nodejs/remark-preset-lint-node/pull/139

PR-URL: https://github.com/nodejs/node/pull/35668
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-10-18 04:55:47 -07:00
Rich Trott 89defff3b9 doc: correct order of metadata for deprecation 
This is in preparation for updating remark-preset-lint-node to 1.17.1.

PR-URL: https://github.com/nodejs/node/pull/35668
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-10-18 04:55:43 -07:00
Rich Trott 7f25fe8b67 fs: remove unused assignment 
PR-URL: https://github.com/nodejs/node/pull/35642
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-10-16 06:31:55 -07:00
Rich Trott 2c2c87e291 doc: fix stability indicator in webcrypto doc 
0 is deprecated. Change to 1, which is experimental.

PR-URL: https://github.com/nodejs/node/pull/35672
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2020-10-16 05:13:29 -07:00
Rich Trott 8a3808dc37 doc: use kbd element in tty doc 
PR-URL: https://github.com/nodejs/node/pull/35613
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-15 03:44:25 -07:00
Rich Trott a844387eaa doc: edit fs.md for minor style changes 
Prefer present tense and use "might" for possibility.

PR-URL: https://github.com/nodejs/node/pull/35505
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-10-12 07:15:25 -07:00
Rich Trott 4952747b37 doc: use kbd element in process doc 
PR-URL: https://github.com/nodejs/node/pull/35584
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-10-12 06:37:06 -07:00
Rich Trott 828518c208 tools: refloat 7 Node.js patches to cpplint.py 
Cherry-pick 12c8b4d154
Original commit message:
    This commit is a suggestion for adding a rule for NULL usages in the
    code base. This will currently report a number of errors which could be
    ignored using // NOLINT (readability/null_usage)

    PR-URL: https://github.com/nodejs/node/pull/17373
    Reviewed-By: Jon Moss <me@jonathanmoss.me>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
    Reviewed-By: Timothy Gu <timothygu99@gmail.com>
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
    Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
    Reviewed-By: Tobias Nießen <tniessen@tnie.de>

Refs: https://github.com/nodejs/node/commit/12c8b4d15471cb6211b39c3a2ca5b10fa4b9f12b

Cherry-pick fc81e80191
Original commit message:

    Update cpplint.py to check for inline headers when the corresponding
    header is already included.

    PR-URL: https://github.com/nodejs/node/pull/21521
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: https://github.com/nodejs/node/commit/fc81e801913de3e3f3c0c8e26c105f983a74e539

Cherry-pick cbc3dd997e
Original commit message:

    src, tools: add check for left leaning pointers

    This commit adds a rule to cpplint to check that pointers in the code
    base lean to the left and not right, and also fixes the violations
    reported.

    PR-URL: https://github.com/nodejs/node/pull/21010
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: Anna Henningsen <anna@addaleax.net>
    Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: https://github.com/nodejs/node/commit/cbc3dd997eb90d629d1b9912b7a5a40eb82343df

Cherry-pick 902998190a
Original commit message:

    tools: fix cpplint.py header rules

    THIS COMMIT SHOULD GO WITH THE NEXT. IT WILL FIND NEW LINT.

    PR-URL: https://github.com/nodejs/node/pull/26306
    Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Refs: https://github.com/nodejs/node/commit/902998190a55d6915b881936f6dd5b6e9cca6ad8

Cherry-pick 0a25ace9c3
Original commit message:

    tools: move cpplint configuration to .cpplint

    PR-URL: https://github.com/nodejs/node/pull/27098
    Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
    Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refs: https://github.com/nodejs/node/commit/0a25ace9c35b62ece4d32fd90b326d8063265109

Cherry-pick afa9a7206c
Original commit message:

    tools: refloat update link to google styleguide for cpplint

    This commit updates two old links to Google's C++ styleguide which
    currently result in a 404 when accessed.

    PR-URL: https://github.com/nodejs/node/pull/30876
    Reviewed-By: Michaël Zasso <targos@protonmail.com>
    Reviewed-By: David Carlier <devnexen@gmail.com>
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Richard Lau <riclau@uk.ibm.com>
    Reviewed-By: Rich Trott <rtrott@gmail.com>

Refs: https://github.com/nodejs/node/commit/afa9a7206c26a29a2af226696c145c924a6d3754

Cherry-pick e23bf8f771
Original commit message:

    tools,src: refloat forbid usage of v8::Persistent

    `v8::Persistent` comes with the surprising catch that it requires
    manual cleanup. `v8::Global` doesn’t, making it easier to use,
    and additionally provides move semantics. New code should always
    use `v8::Global`.

    PR-URL: https://github.com/nodejs/node/pull/31018
    Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
    Reviewed-By: Richard Lau <riclau@uk.ibm.com>
    Reviewed-By: James M Snell <jasnell@gmail.com>
    Reviewed-By: David Carlier <devnexen@gmail.com>
    Reviewed-By: Rich Trott <rtrott@gmail.com>
    Reviewed-By: Gus Caplan <me@gus.host>
    Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
    Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
    Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>

PR-URL: https://github.com/nodejs/node/pull/35569
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
 2020-10-11 06:14:03 -07:00
Rich Trott 7dd786bb89 tools: bump cpplint.py to 1.4.6 
Refs: https://github.com/cpplint/cpplint/releases/tag/1.4.6

PR-URL: https://github.com/nodejs/node/pull/35569
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
 2020-10-11 06:13:46 -07:00
Rich Trott 91f0544889 doc: improve SIGINT error text 
* add kbd elements
* correct period/parenthesis order
* make fragment a full sentence

PR-URL: https://github.com/nodejs/node/pull/35558
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
 2020-10-10 05:16:37 -07:00
Rich Trott 936ce85c0b doc: use sentence case for class property 
Change the one instance of the Class Property heading in our docs to
Class property to match style with other headers.

PR-URL: https://github.com/nodejs/node/pull/35540
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-10-09 06:10:16 -07:00
Rich Trott ce84bacdc6 doc: improve kbd element rendering 
* better vertical alignment with text
* slightly larger "key" size
* remove top light area (from box-shadow)

PR-URL: https://github.com/nodejs/node/pull/35497
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-10-08 04:43:42 -07:00
Rich Trott 27c77b9350 tools,test: enable multiline-comment-style rule in tests 
Use `//` for multline comments.

PR-URL: https://github.com/nodejs/node/pull/35485
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-07 04:36:10 -07:00
Rich Trott f593f9e9ef test: adjust comments for upcoming lint rule 
Enforce `//` for multiline comments. Some tests mixed and matched, and
at least one did so in a (to me) surprising way.

PR-URL: https://github.com/nodejs/node/pull/35485
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-07 04:36:02 -07:00
Rich Trott cd226c0305 doc: adopt MDN style for kbd elements 
PR-URL: https://github.com/nodejs/node/pull/35460
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-04 05:34:14 -07:00
Rich Trott e9639ee7e8 tools,doc: fix broken link in module.html 
Update tools/doc/type-parser.js with correct URL for the
module.SourceMap class. This fixes a broken link in our documentation.

PR-URL: https://github.com/nodejs/node/pull/35446
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
 2020-10-03 05:41:50 -07:00
Rich Trott fb33cc395e doc: copyedit packages.md 
Some minor adjustments, mostly moving things to present tense and
avoiding the ambiguity of _may_.

Refs: https://github.com/nodejs/node/pull/35370#issuecomment-700798044

PR-URL: https://github.com/nodejs/node/pull/35427
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-03 05:38:12 -07:00
Rich TrottandGuy Bedford fa73561fca doc: copyedit esm.md 
This provides a number of minor style adjustments and small corrections
to esm.md text.

Co-authored-by: Guy Bedford <guybedford@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/35414
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
 2020-10-02 04:38:07 -07:00
Rich Trott aa3746d0a6 doc: implement fancier rendering for keys 
Minimal CSS and markup changes to implement special rendering for
`<kbd>` elements.

PR-URL: https://github.com/nodejs/node/pull/35400
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
 2020-10-02 03:27:05 -07:00
Rich Trott 606df7c4e7 doc: make minor edits for consistency 
* We use _noop_ and _no-op_ in different docs. Use _no-op_ everywhere.
* When referring to functions, add _()_ to indicate that.
* Remove backticks from non-code _destroyed_.

PR-URL: https://github.com/nodejs/node/pull/35377
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-29 21:40:12 +00:00
Rich Trott 062b35d4e8 doc: edit n-api.md for minor improvements 
Not a comprehensive edit. Just a few things I noticed.

* Favor present tense where there's a choice
* Added a comma for clarity
* Added a missing word ("in")

PR-URL: https://github.com/nodejs/node/pull/35361
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-09-28 09:28:13 -07:00
Rich Trott eec4a5b671 repl: standardize Control key indications 
Throughout our messages and docs, we refer to the Control key in a
surprisingly varied number of ways:

* Control
* Ctrl
* Cntl
* varied capitalization on the above (e.g., ctrl vs. Ctrl)

Then, in key combinations:

* One of the items from the previous list followed by `-`
* ... or followed by `+`
* ... surrounded or not by `<` and `>`
* ... and inside backticks or not
* ... or just `^`

This is the start of standardization on the formulation recommended by
the Microsoft Style Guide (e.g., **Ctrl+C**).

PR-URL: https://github.com/nodejs/node/pull/35270
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
 2020-09-28 06:55:07 -07:00
Rich Trott c3ab062ae5 doc: revise introductory child_process text 
This consolidates information about Windows environment variables and
has a few other smaller improvements (punctuation, present tense, etc.).

PR-URL: https://github.com/nodejs/node/pull/35344
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-27 07:17:54 -07:00
Rich Trott 325df03a6e test,child_process: add tests for signalCode value 
Prior to this change, none of the child_process tests checked the
signalCode property for a value other than null. Add a check to an
existing test.

PR-URL: https://github.com/nodejs/node/pull/35327
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
 2020-09-26 06:43:04 -07:00
Rich TrottandAnna Henningsen c25cf34ac1 doc: move DEP0018 to End-of-Life 
3b10f7f93 resolves DEP0018. Move it to End-of-Life.

Co-authored-by: Anna Henningsen <github@addaleax.net>

PR-URL: https://github.com/nodejs/node/pull/35316
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
 2020-09-25 10:50:31 -07:00
Rich TrottandShelley Vohr 895832cdbf doc: put landing specifics in details tag 
Showing all the steps isn't usually useful and makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Co-authored-by: Shelley Vohr <codebytere@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/35296
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
 2020-09-25 07:54:12 -07:00
Rich Trott 9687348577 doc: replace "this guide" link text with guide title 
PR-URL: https://github.com/nodejs/node/pull/35283
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-24 04:32:43 -07:00
Rich Trott 163030eded doc: revise dependency redirection text in policy.md 
PR-URL: https://github.com/nodejs/node/pull/35276
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-24 04:30:35 -07:00
Rich Trott 98768f3b5b doc: edit subpath export patterns introduction 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

PR-URL: https://github.com/nodejs/node/pull/35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
 2020-09-21 07:20:31 -07:00
Rich Trott 039c274dde doc: standardize on _backward_ 
We use _backward incompatible_ and _backwards incompatible_ with no
discernible pattern in the docs. Follow Chicago Manual of Style and also
our standardization on US English and favor _backward_.

PR-URL: https://github.com/nodejs/node/pull/35243
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
 2020-09-20 07:49:06 -07:00
Rich Trott c31ef9827e doc: revise stability section of values doc 
Make the section a bit shorter and comply with minor elements of
Microsoft Style Guide.

PR-URL: https://github.com/nodejs/node/pull/35242
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-09-20 07:47:01 -07:00
Rich Trott 87c433e120 test: improve assertions in pummel/test-timers 
* Timers should not fire early. Check for that.
* Allow the wiggle-room to increase on subsequent iterations of
  intervals.

PR-URL: https://github.com/nodejs/node/pull/35216
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
 2020-09-20 07:44:40 -07:00
Rich Trott 62ff6912c3 doc: clarify napi_property_attributes text 
* Rearrange sentence to avoid ambiguity whether the entire sentence
  applies to a method in a JS class or just the "but not" part
* Use serial comma
* Correct spelling of _configurable_

PR-URL: https://github.com/nodejs/node/pull/35253
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-09-20 16:34:41 +02:00
Rich Trott 770ad3a52d doc: remove excessive formatting in dgram.md 
PR-URL: https://github.com/nodejs/node/pull/35234
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-19 06:10:21 -07:00
Rich Trott 4c5bb1a1c7 doc: sort repl references in ASCII order 
PR-URL: https://github.com/nodejs/node/pull/35230
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-09-19 06:08:29 -07:00
Rich Trott 448834c950 doc: relax prohibition on personal pronouns 
Our personal pronoun prohibition is contrary to most current technical
documentation style guides. The prohibition on personal pronouns comes
from academic style guides. It results in an unnecessary formal tone. It
encourages wordiness and the overuse of passive voice.

This change to our style guide more closely aligns us with the style
guides of companies like Google, IBM, and  Microsoft.

Google's style guide suggests avoiding first-person pronouns and
suggests: "Use the second-person pronoun (_you_) whenever possible."
Refs: https://developers.google.com/style/pronouns#personal-pronouns

IBM's style guide also recommends second-person voice ("Use second
person ('you')").
Refs: https://www.ibm.com/developerworks/library/styleguidelines/index.html

Similarly, Microsoft's style guide recommends using first person
sparingly and avoiding first-person plural. "In general, use second
person".
Refs: https://docs.microsoft.com/en-us/style-guide/grammar/person#in-general-use-second-person

PR-URL: https://github.com/nodejs/node/pull/34353
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-19 06:05:31 -07:00
Rich Trott 14e98825a1 doc: alphabetize error list 
PR-URL: https://github.com/nodejs/node/pull/35219
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-18 02:21:48 -07:00
Rich Trott 018a6a4ab1 doc: fix header level for error code 
PR-URL: https://github.com/nodejs/node/pull/35219
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-18 02:21:46 -07:00
Rich Trott 72e2029811 doc: remove "end user" 
We use "end user" in ambiguous ways. Sometimes we mean the developer,
and sometimes we mean the application user. Use "developer" where
developer is meant.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/u/user-end-user

PR-URL: https://github.com/nodejs/node/pull/35200
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-09-17 08:34:47 -07:00
Rich Trott c205f672e9 doc: use command-line/command line consistently 
Docs switch between "command line" and "command-line" with no apparent
uniformity. Microsoft Style Guide prescribes "command line" as a noun
and "command-line" as a modifier, which makes a lot of sense to me.
Updating docs as appropriate.

PR-URL: https://github.com/nodejs/node/pull/35198
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-17 02:01:07 -07:00
Rich Trott 18462e0c1d doc: replace "you should do X" with "do X" 
PR-URL: https://github.com/nodejs/node/pull/35194
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-09-16 13:24:03 -07:00
Rich Trott 3aab64cd5f doc: fix broken link in crypto.md 
URL that lacks a scheme gets treated as a relative URL. Add missing
`https://`.

PR-URL: https://github.com/nodejs/node/pull/35181
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-16 06:11:52 -07:00
Rich Trott ae257ca000 test: improve pummel/test-timers.js 
* use Date.now() instead of new Date() because only the timestamp is
  ever used, so we don't need the full Date object
* use separate start times recorded for the two different test cases
* improve assertion messages

PR-URL: https://github.com/nodejs/node/pull/35175
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
 2020-09-15 10:51:36 -07:00
Rich Trott 26e660f962 doc: remove problematic auto-linking of curl man pages 
The only instance of curl man page linking is in repl.md and it is
explicit. The magic autolinking in html.js creates a superfluous empty
link. Remove it.

Before, two adjacent links generated, with the first one having no text:

```html
<a href="https://curl.haxx.se/docs/manpage.html"></a>
<a href="https://curl.haxx.se/docs/manpage.html"><code>curl(1)</code></a>
```

After, just one link:

```html
<a href="https://curl.haxx.se/docs/manpage.html"><code>curl(1)</code></a>
```

PR-URL: https://github.com/nodejs/node/pull/35174
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-15 10:50:09 -07:00
Rich Trott fb1ab19894 doc: fix broken links in modules.md 
PR-URL: https://github.com/nodejs/node/pull/35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-14 12:42:08 -07:00
Rich Trott 9d12c14b19 doc: use present tense in error messages 
Error messages are a mix of present and past tense. They should be
mostly or entirely present tense. This eliminates the past tense
constructions "was found" and "were found".

PR-URL: https://github.com/nodejs/node/pull/35164
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-13 21:45:51 -07:00
Rich Trott b569376156 doc: remove http2 non-link anchor tags 
Headers have ids automatically assigned. Removed ad hoc ids using anchor
tags that aren't links.

PR-URL: https://github.com/nodejs/node/pull/35161
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-13 21:44:41 -07:00
Rich Trott b5715d2283 doc: perform cleanup on security-release-process.md 
These are exceedingly minor, but I'm doing them anyway for consistency
across our docs (whether internal process docs or user-facing docs).

* ASCII order for references
* Minor punctuation adjustments
* Use product capitalization for Twitter and Slack
* Sentence-case for header

PR-URL: https://github.com/nodejs/node/pull/35154
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-09-13 16:06:19 -07:00
Rich Trott 4109903098 doc: perform minor cleanup on cli.md 
* sort references in ASCII order
* merge logically-connected single-sentence paragraphs
* remove _please_ from referrals to other docs
* remove unnecessary italics
* make some text more concise
* change some instances of future tense to present tense

PR-URL: https://github.com/nodejs/node/pull/35152
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
 2020-09-13 05:50:18 -07:00
Rich Trott b123e0806f doc: improve table accessibility 
The compatibility matrix in the N-API doc needs row headers for
accessibility purposes. Unfortunately, those aren't possible in markdown
without resorting to HTML markup. So this converts the table from
markdown to HTML. This is less convenient for documentation authors and
for other readers of the raw markdown docs, but I believe accessibility
for the viewers of our HTML docs outweighs that concern.

PR-URL: https://github.com/nodejs/node/pull/35146
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
 2020-09-12 10:06:05 -07:00
Rich Trott 4fdc5ace6a doc: fix left nav color contrast 
I believe this is the last change to make in the docs for color contrast
accessibility per WCAG AA.

Currently, the current item in the nav is #43853d on a #333333
background for a color contrast of 2.8:1, failing WCAG AA. This swaps in
removes a confusing bottom border on the item, replacing it with
bolding to preserve the item's highlighting.

PR-URL: https://github.com/nodejs/node/pull/35141
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-12 09:49:23 -07:00
Rich Trott 1df50ffb55 doc: simplify circular dependencies text in modules.md 
PR-URL: https://github.com/nodejs/node/pull/35126
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-11 16:29:46 -07:00
Rich Trott f54254afed errors: simplify ERR_REQUIRE_ESM message generation 
Because of the condition that starts the `if` block, we know that
`parentPath` must be truthy. So there is no need to check for that in
the template string that generates the error message.

PR-URL: https://github.com/nodejs/node/pull/35123
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
 2020-09-11 16:26:00 -07:00
Rich Trott 4f176c9110 doc: fix broken link in perf_hooks.md 
PR-URL: https://github.com/nodejs/node/pull/35113
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-10 20:15:29 -07:00
Rich Trott 85624fd129 doc: fix broken link in http2.md 
PR-URL: https://github.com/nodejs/node/pull/35112
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ricky Zhou <0x19951125@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-10 19:46:29 -07:00
Rich Trott e0a3faeff7 doc: fix broken link in fs.md 
PR-URL: https://github.com/nodejs/node/pull/35111
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-10 19:44:38 -07:00
Rich Trott 2f6bf7a791 doc: fix broken links in deprecations.md 
PR-URL: https://github.com/nodejs/node/pull/35109
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-10 19:42:54 -07:00
Rich Trott 7fc1a4a893 test: revise test-policy-integrity 
* eliminate unneeded Set deletion/cleanup
* use number of CPUs as limit for processes spawned rather than
  hard-coding the limit

PR-URL: https://github.com/nodejs/node/pull/35101
Reviewed-By: Bradley Farias <bradley.meck@gmail.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
 2020-09-10 06:09:23 -07:00
Rich Trott 661b770e11 doc: restore color for visited links 
A previous change altered the rendering of visited links. This restores
it.

PR-URL: https://github.com/nodejs/node/pull/35108
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
 2020-09-10 05:33:35 -04:00
Rich Trott 4c9b79ed5a doc: avoid double-while sentence in perf_hooks.md 
This improves readability, as well as awkward reptition of the word
_while_ with two different meanings in a single sentence.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/w/while

PR-URL: https://github.com/nodejs/node/pull/35078
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
 2020-09-09 19:47:10 -07:00