From 5714e7e83d1069fe8bbc82f9702f515bcf33c1c6 Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Tue, 29 Oct 2019 16:43:35 +0100 Subject: [PATCH] doc: linkify `.fork()` in cluster documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/30163 Reviewed-By: Colin Ihrig Reviewed-By: David Carlier Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca Reviewed-By: Tobias Nießen --- doc/api/cluster.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 179a775074a394..c4a47539472cb3 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -531,7 +531,7 @@ added: v0.7.9 When any of the workers die the cluster module will emit the `'exit'` event. -This can be used to restart the worker by calling `.fork()` again. +This can be used to restart the worker by calling [`.fork()`][] again. ```js cluster.on('exit', (worker, code, signal) => { @@ -760,8 +760,8 @@ changes: * `windowsHide` {boolean} Hide the forked processes console window that would normally be created on Windows systems. **Default:** `false`. -After calling `.setupMaster()` (or `.fork()`) this settings object will contain -the settings, including the default values. +After calling [`.setupMaster()`][] (or [`.fork()`][]) this settings object will +contain the settings, including the default values. This object is not intended to be changed or set manually. @@ -779,11 +779,11 @@ changes: `setupMaster` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`. -Any settings changes only affect future calls to `.fork()` and have no +Any settings changes only affect future calls to [`.fork()`][] and have no effect on workers that are already running. The only attribute of a worker that cannot be set via `.setupMaster()` is -the `env` passed to `.fork()`. +the `env` passed to [`.fork()`][]. The defaults above apply to the first call only; the defaults for later calls are the current values at the time of `cluster.setupMaster()` is called. @@ -862,6 +862,8 @@ socket.on('data', (id) => { }); ``` +[`.fork()`]: #cluster_cluster_fork_env +[`.setupMaster()`]: #cluster_cluster_setupmaster_settings [`ChildProcess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback [`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options [`child_process` event: `'exit'`]: child_process.html#child_process_event_exit