From b753a51db7db3fbbda53580568df084e052a8939 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 4 Jan 2018 19:01:22 -0800 Subject: [PATCH 1/4] doc: use serial comma in child_process.md --- doc/api/child_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 2f86d5156fc438..3855d6585016f4 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -25,7 +25,7 @@ ls.on('close', (code) => { }); ``` -By default, pipes for `stdin`, `stdout` and `stderr` are established between +By default, pipes for `stdin`, `stdout`, and `stderr` are established between the parent Node.js process and the spawned child. It is possible to stream data through these pipes in a non-blocking way. *Note, however, that some programs use line-buffered I/O internally. While that does not affect Node.js, it can From a65edd3053620153bbe54ce2441163e601f97a76 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 4 Jan 2018 19:01:46 -0800 Subject: [PATCH 2/4] doc: use American spelling of unsanitized in child_process.md --- doc/api/child_process.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 3855d6585016f4..da1006b59076c9 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -170,7 +170,7 @@ exec('echo "The \\$HOME variable is $HOME"'); //The $HOME variable is escaped in the first instance, but not in the second ``` -*Note*: Never pass unsanitised user input to this function. Any input +*Note*: Never pass unsanitized user input to this function. Any input containing shell metacharacters may be used to trigger arbitrary command execution. @@ -418,7 +418,7 @@ The `child_process.spawn()` method spawns a new process using the given `command`, with command line arguments in `args`. If omitted, `args` defaults to an empty array. -*Note*: If the `shell` option is enabled, do not pass unsanitised user input to +*Note*: If the `shell` option is enabled, do not pass unsanitized user input to this function. Any input containing shell metacharacters may be used to trigger arbitrary command execution. @@ -771,7 +771,7 @@ If the process times out, or has a non-zero exit code, this method ***will*** throw. The [`Error`][] object will contain the entire result from [`child_process.spawnSync()`][] -*Note*: Never pass unsanitised user input to this function. Any input +*Note*: Never pass unsanitized user input to this function. Any input containing shell metacharacters may be used to trigger arbitrary command execution. @@ -839,7 +839,7 @@ completely exited. Note that if the process intercepts and handles the `SIGTERM` signal and doesn't exit, the parent process will wait until the child process has exited. -*Note*: If the `shell` option is enabled, do not pass unsanitised user input +*Note*: If the `shell` option is enabled, do not pass unsanitized user input to this function. Any input containing shell metacharacters may be used to trigger arbitrary command execution. From 40273cc0984662344c0356d12bec368d4f362b04 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 4 Jan 2018 19:05:42 -0800 Subject: [PATCH 3/4] doc: hyphenate general-purpose in child_process.md --- doc/api/child_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index da1006b59076c9..d475f6d5b16033 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -661,7 +661,7 @@ The [`child_process.spawnSync()`][], [`child_process.execSync()`][], and the Node.js event loop, pausing execution of any additional code until the spawned process exits. -Blocking calls like these are mostly useful for simplifying general purpose +Blocking calls like these are mostly useful for simplifying general-purpose scripting tasks and for simplifying the loading/processing of application configuration at startup. From a5eff0ae3b2bc0e741b1f0fbff94361ba94b9fd6 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 4 Jan 2018 19:07:14 -0800 Subject: [PATCH 4/4] doc: remove errant commas in child_process.md --- doc/api/child_process.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index d475f6d5b16033..c88443e078b0a6 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -715,7 +715,7 @@ completely exited. does not exit, the parent process will still wait until the child process has exited. -If the process times out, or has a non-zero exit code, this method ***will*** +If the process times out or has a non-zero exit code, this method ***will*** throw an [`Error`][] that will include the full result of the underlying [`child_process.spawnSync()`][]. @@ -767,7 +767,7 @@ exited. *Note that if the child process intercepts and handles the `SIGTERM` signal and doesn't exit, the parent process will wait until the child process has exited.* -If the process times out, or has a non-zero exit code, this method ***will*** +If the process times out or has a non-zero exit code, this method ***will*** throw. The [`Error`][] object will contain the entire result from [`child_process.spawnSync()`][]