From 9585d5d6de479be3e66abb398ced26d9403073c2 Mon Sep 17 00:00:00 2001 From: Jucke Date: Sat, 18 Jul 2020 15:00:36 +0100 Subject: [PATCH 1/2] doc: fix typos in n-api, tls and worker_threads --- doc/api/n-api.md | 2 +- doc/api/tls.md | 6 +++--- doc/api/worker_threads.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 10da5043e2fa14..ddfe9fb490641c 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -127,7 +127,7 @@ the native addon will also need to have a C/C++ toolchain installed. For Linux developers, the necessary C/C++ toolchain packages are readily available. [GCC][] is widely used in the Node.js community to build and -test across a variety of plarforms. For many developers, the [LLVM][] +test across a variety of platforms. For many developers, the [LLVM][] compiler infrastructure is also a good choice. For Mac developers, [Xcode][] offers all the required compiler tools. diff --git a/doc/api/tls.md b/doc/api/tls.md index c35db89246a127..b813c506d011ef 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -85,8 +85,8 @@ all sessions). Methods implementing this technique are called "ephemeral". Currently two methods are commonly used to achieve perfect forward secrecy (note the character "E" appended to the traditional abbreviations): -* [DHE][]: An ephemeral version of the Diffie Hellman key-agreement protocol. -* [ECDHE][]: An ephemeral version of the Elliptic Curve Diffie Hellman +* [DHE][]: An ephemeral version of the Diffie-Hellman key-agreement protocol. +* [ECDHE][]: An ephemeral version of the Elliptic Curve Diffie-Hellman key-agreement protocol. Ephemeral methods may have some performance drawbacks, because key generation @@ -1562,7 +1562,7 @@ changes: client certificate. * `crl` {string|string[]|Buffer|Buffer[]} PEM formatted CRLs (Certificate Revocation Lists). - * `dhparam` {string|Buffer} Diffie Hellman parameters, required for + * `dhparam` {string|Buffer} Diffie-Hellman parameters, required for [perfect forward secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 7dd74675585019..96d0e109355c5b 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -110,7 +110,7 @@ const { port1 } = new MessageChannel(); port1.postMessage(typedArray1, [ typedArray1.buffer ]); // The following line prints the contents of typedArray1 -- it still owns its -// memory and has been cloned, not transfered. Without `markAsUntransferable()`, +// memory and has been cloned, not transferred. Without `markAsUntransferable()`, // this would print an empty Uint8Array. typedArray2 is intact as well. console.log(typedArray1); console.log(typedArray2); From 7c93cec7cecb28e461834862c6b744c714220914 Mon Sep 17 00:00:00 2001 From: Jucke Date: Sat, 18 Jul 2020 15:26:54 +0100 Subject: [PATCH 2/2] doc: fix line length in worker_threads.md --- doc/api/worker_threads.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 96d0e109355c5b..e6d4bc6acfbcfb 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -109,9 +109,10 @@ markAsUntransferable(pooledBuffer); const { port1 } = new MessageChannel(); port1.postMessage(typedArray1, [ typedArray1.buffer ]); -// The following line prints the contents of typedArray1 -- it still owns its -// memory and has been cloned, not transferred. Without `markAsUntransferable()`, -// this would print an empty Uint8Array. typedArray2 is intact as well. +// The following line prints the contents of typedArray1 -- it still owns +// its memory and has been cloned, not transferred. Without +// `markAsUntransferable()`, this would print an empty Uint8Array. +// typedArray2 is intact as well. console.log(typedArray1); console.log(typedArray2); ```