Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2020-06-15 00:49:34 +0300
committerRich Trott <rtrott@gmail.com>2020-06-19 18:09:05 +0300
commitd1d412b413d2f8febb1795459ff04c36c9c87f2c (patch)
treefeeb2d25788a98693c3bf23975d163a67827091e /doc/api/child_process.md
parent9918bdf5cb07f58d230522244a372cbb1b510956 (diff)
doc: use sentence-case for headings in docs
PR-URL: https://github.com/nodejs/node/pull/33889 Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/child_process.md')
-rw-r--r--doc/api/child_process.md44
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index 2f18567737e..ba29c0dc5f0 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -1,4 +1,4 @@
-# Child Process
+# Child process
<!--introduced_in=v0.10.0-->
@@ -70,7 +70,7 @@ For certain use cases, such as automating shell scripts, the
the synchronous methods can have significant impact on performance due to
stalling the event loop while spawned processes complete.
-## Asynchronous Process Creation
+## Asynchronous process creation
The [`child_process.spawn()`][], [`child_process.fork()`][], [`child_process.exec()`][],
and [`child_process.execFile()`][] methods all follow the idiomatic asynchronous
@@ -153,7 +153,7 @@ changes:
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
* `encoding` {string} **Default:** `'utf8'`
* `shell` {string} Shell to execute the command with. See
- [Shell Requirements][] and [Default Windows Shell][]. **Default:**
+ [Shell requirements][] and [Default Windows shell][]. **Default:**
`'/bin/sh'` on Unix, `process.env.ComSpec` on Windows.
* `timeout` {number} **Default:** `0`
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
@@ -270,8 +270,8 @@ changes:
done on Windows. Ignored on Unix. **Default:** `false`.
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
- shell can be specified as a string. See [Shell Requirements][] and
- [Default Windows Shell][]. **Default:** `false` (no shell).
+ shell can be specified as a string. See [Shell requirements][] and
+ [Default Windows shell][]. **Default:** `false` (no shell).
* `callback` {Function} Called with the output when process terminates.
* `error` {Error}
* `stdout` {string|Buffer}
@@ -355,7 +355,7 @@ changes:
**Default:** `process.execArgv`.
* `serialization` {string} Specify the kind of serialization used for sending
messages between processes. Possible values are `'json'` and `'advanced'`.
- See [Advanced Serialization][] for more details. **Default:** `'json'`.
+ See [Advanced serialization][] for more details. **Default:** `'json'`.
* `silent` {boolean} If `true`, stdin, stdout, and stderr of the child will be
piped to the parent, otherwise they will be inherited from the parent, see
the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s
@@ -434,11 +434,11 @@ changes:
* `gid` {number} Sets the group identity of the process (see setgid(2)).
* `serialization` {string} Specify the kind of serialization used for sending
messages between processes. Possible values are `'json'` and `'advanced'`.
- See [Advanced Serialization][] for more details. **Default:** `'json'`.
+ See [Advanced serialization][] for more details. **Default:** `'json'`.
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
- shell can be specified as a string. See [Shell Requirements][] and
- [Default Windows Shell][]. **Default:** `false` (no shell).
+ shell can be specified as a string. See [Shell requirements][] and
+ [Default Windows shell][]. **Default:** `false` (no shell).
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. This is set to `true` automatically
when `shell` is specified and is CMD. **Default:** `false`.
@@ -699,7 +699,7 @@ see [V8 issue 7381](https://bugs.chromium.org/p/v8/issues/detail?id=7381).
See also: [`child_process.exec()`][] and [`child_process.fork()`][].
-## Synchronous Process Creation
+## Synchronous process creation
The [`child_process.spawnSync()`][], [`child_process.execSync()`][], and
[`child_process.execFileSync()`][] methods are synchronous and will block the
@@ -755,8 +755,8 @@ changes:
normally be created on Windows systems. **Default:** `false`.
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
- shell can be specified as a string. See [Shell Requirements][] and
- [Default Windows Shell][]. **Default:** `false` (no shell).
+ shell can be specified as a string. See [Shell requirements][] and
+ [Default Windows shell][]. **Default:** `false` (no shell).
* Returns: {Buffer|string} The stdout from the command.
The `child_process.execFileSync()` method is generally identical to
@@ -804,7 +804,7 @@ changes:
**Default:** `'pipe'`.
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
* `shell` {string} Shell to execute the command with. See
- [Shell Requirements][] and [Default Windows Shell][]. **Default:**
+ [Shell requirements][] and [Default Windows shell][]. **Default:**
`'/bin/sh'` on Unix, `process.env.ComSpec` on Windows.
* `uid` {number} Sets the user identity of the process. (See setuid(2)).
* `gid` {number} Sets the group identity of the process. (See setgid(2)).
@@ -884,8 +884,8 @@ changes:
**Default:** `'buffer'`.
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
- shell can be specified as a string. See [Shell Requirements][] and
- [Default Windows Shell][]. **Default:** `false` (no shell).
+ shell can be specified as a string. See [Shell requirements][] and
+ [Default Windows shell][]. **Default:** `false` (no shell).
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. This is set to `true` automatically
when `shell` is specified and is CMD. **Default:** `false`.
@@ -1025,7 +1025,7 @@ message might not be the same as what is originally sent.
If the `serialization` option was set to `'advanced'` used when spawning the
child process, the `message` argument can contain data that JSON is not able
to represent.
-See [Advanced Serialization][] for more details.
+See [Advanced serialization][] for more details.
### `subprocess.channel`
<!-- YAML
@@ -1543,13 +1543,13 @@ This impacts output that includes multibyte character encodings such as UTF-8 or
UTF-16. For instance, `console.log('中文测试')` will send 13 UTF-8 encoded bytes
to `stdout` although there are only 4 characters.
-## Shell Requirements
+## Shell requirements
The shell should understand the `-c` switch. If the shell is `'cmd.exe'`, it
should understand the `/d /s /c` switches and command line parsing should be
compatible.
-## Default Windows Shell
+## Default Windows shell
Although Microsoft specifies `%COMSPEC%` must contain the path to
`'cmd.exe'` in the root environment, child processes are not always subject to
@@ -1557,7 +1557,7 @@ the same requirement. Thus, in `child_process` functions where a shell can be
spawned, `'cmd.exe'` is used as a fallback if `process.env.ComSpec` is
unavailable.
-## Advanced Serialization
+## Advanced serialization
<!-- YAML
added:
- v13.2.0
@@ -1578,7 +1578,7 @@ Therefore, this feature requires opting in by setting the
`serialization` option to `'advanced'` when calling [`child_process.spawn()`][]
or [`child_process.fork()`][].
-[Advanced Serialization]: #child_process_advanced_serialization
+[Advanced serialization]: #child_process_advanced_serialization
[`'disconnect'`]: process.html#process_event_disconnect
[`'error'`]: #child_process_event_error
[`'exit'`]: #child_process_event_exit
@@ -1611,8 +1611,8 @@ or [`child_process.fork()`][].
[`subprocess.stdio`]: #child_process_subprocess_stdio
[`subprocess.stdout`]: #child_process_subprocess_stdout
[`util.promisify()`]: util.html#util_util_promisify_original
-[Default Windows Shell]: #child_process_default_windows_shell
+[Default Windows shell]: #child_process_default_windows_shell
[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
-[Shell Requirements]: #child_process_shell_requirements
+[Shell requirements]: #child_process_shell_requirements
[synchronous counterparts]: #child_process_synchronous_process_creation
[v8.serdes]: v8.html#v8_serialization_api