doc: improvements to child_process, process docs #5075

estliberitas · 2016-02-04T13:14:02Z

Sort links in lexical order. Add missing links.
Add disconnect event description in Process doc.
Fix typos.

estliberitas · 2016-02-04T13:14:43Z

doc/api/child_process.markdown

@@ -483,7 +499,7 @@ spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });
 *It is worth noting that when an IPC channel is established between the
 parent and child processes, and the child is a Node.js process, the child
 is launched with the IPC channel unreferenced (using `unref()`) until the
-child registers an event handler for the `process.on('disconnected')` event.
+child registers an event handler for the [`process.on('disconnect')`][] event.


Am I correct here? I did not found any mentioning of 'disconnected' event in source, so corrected this.

@trevnorris @nodejs/ctc

Yes, a search of the codebase turns up emit('disconnect'), but not disconnected.

estliberitas · 2016-02-10T20:40:17Z

Seems I have to rebase, okay.

estliberitas · 2016-02-10T20:51:54Z

Rebased.

silverwind · 2016-02-16T10:42:43Z

doc/api/child_process.markdown

-without blocking the Node.js event loop. The `child_process.spawnSync()`
-function provides equivalent functionality in a synchronous manner that blocks
-the event loop until the spawned process either exits of is terminated.
+The  [`child_process.spawn()`][]  method spawns the child process


double space

@silverwind fixed

sam-github · 2016-02-18T21:05:01Z

This is difficult to review, because of all the line re-wrapping, and the mixture of markup changes, and actual text content changes - I wish those two had been separate PRs.

sam-github · 2016-02-18T21:06:41Z

doc/api/child_process.markdown

+[`child_process.spawn()`][] with the `shell` option set, with
+[`child_process.exec()`][], or by spawning `cmd.exe` and passing the `.bat` or
+`.cmd` file as an argument (which is what the `shell` option and
+[`child_process.exec()`][] do).


Its basically impossible to tell during review without an eyeball straining line-by-line review whether you have just added markdown links to the above, or whether you also made some changes to the docs.

The markup changes can get rubber stamped if they look OK after converting to html, text changes need closer review.

Ok, I'll try to rebase and avoid word wrapping.

jasnell · 2016-02-19T18:48:40Z

LGTM

jasnell · 2016-04-02T05:53:33Z

@nodejs/documentation ... can we get another review on this?

eljefedelrodeodeljefe · 2016-04-02T19:29:33Z

doc/api/child_process.markdown

@@ -3,8 +3,8 @@
    Stability: 2 - Stable

 The `child_process` module provides the ability to spawn child processes in
-a manner that is similar, but not identical, to [`popen(3)`][]. This capability
-is primarily provided by the `child_process.spawn()` function:
+a manner that is similar, but not identical, to popen(3). This capability


Please keep this reference to man pages.

@eljefedelrodeodeljefe Maybe no need in keeping links anymore thus #5073 landed?

eljefedelrodeodeljefe · 2016-04-02T19:33:52Z

With nits concerning man page links ~~and a little bit indecisive about: ChildProcess# -> child, but this probably has better readability~~.

LGTM

eljefedelrodeodeljefe · 2016-04-03T08:45:00Z

@estliberitas that's right. Then just the exec(3) change. Thanks! LGTM

estliberitas · 2016-04-04T06:58:37Z

@eljefedelrodeodeljefe done

sam-github · 2016-04-05T14:25:12Z

doc/api/child_process.markdown

-be launched using `child_process.execFile()`. When running on Windows, `.bat`
-and `.cmd` files can be invoked using `child_process.spawn()` with the `shell`
-option set, with `child_process.exec()`, or by spawning `cmd.exe` and passing
+be launched using [`child_process.execFile()`][]. When running on Windows, `.bat`


Unrelated to this PR, but perhaps you can fix: turns out that .bat/.exe/.com are directly executable by spawn, but .cmd, .pl, .js etc. are not. This means that npm installed node scripts are not executable.

@sam-github Mean, send PR to npm folks?)

estliberitas · 2016-04-10T15:33:55Z

@sam-github Done.

sam-github · 2016-04-12T15:31:23Z

looks good to me, but you'll have to rebase and resolve the conflicts.

estliberitas · 2016-04-14T11:41:49Z

@sam-github done

jasnell · 2016-04-21T17:52:19Z

@estliberitas ... very sorry but this is going to need another rebase.
@nodejs/documentation ... can we get a final round of reviews on this one please?

silverwind · 2016-04-21T17:55:10Z

LGTM

estliberitas · 2016-04-21T18:22:40Z

Ok will do in some hrs

Sort links in lexical order. Add missing links. Add `disconnect` event description in Process doc. Fix typos.

estliberitas · 2016-04-22T07:18:01Z

Hi. Rebased.

Sort links in lexical order. Add missing links. Add `disconnect` event description in Process doc. Fix typos. R-URL: #5075 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>

jasnell · 2016-04-22T15:40:15Z

Landed in f85412d

Sort links in lexical order. Add missing links. Add `disconnect` event description in Process doc. Fix typos. R-URL: nodejs#5075 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>

Sort links in lexical order. Add missing links. Add `disconnect` event description in Process doc. Fix typos. R-URL: #5075 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>

Ref: #6911 Ref: #5075 PR-URL: #6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

Ref: nodejs#6911 Ref: nodejs#5075 PR-URL: nodejs#6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

MylesBorins · 2016-06-01T22:09:26Z

dropping lts watch as this does not land cleanly... please feel free to open a new PR backporting this directly to v4.x-staging

Ref: #6911 Ref: #5075 PR-URL: #6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

estliberitas reviewed Feb 4, 2016
View reviewed changes

thefourtheye added the doc Issues and PRs related to the documentations. label Feb 4, 2016

estliberitas mentioned this pull request Feb 4, 2016

doc: link to man pages #5073

Closed

jasnell added the lts-watch-v4.x label Feb 4, 2016

mscdex added child_process Issues and PRs related to the child_process subsystem. process Issues and PRs related to the process subsystem. labels Feb 4, 2016

silverwind reviewed Feb 16, 2016
View reviewed changes

sam-github reviewed Feb 18, 2016
View reviewed changes

eljefedelrodeodeljefe reviewed Apr 2, 2016
View reviewed changes

sam-github reviewed Apr 5, 2016
View reviewed changes

doc: improvements to child_process, process docs

0bb6300

Sort links in lexical order. Add missing links. Add `disconnect` event description in Process doc. Fix typos.

jasnell closed this Apr 22, 2016

eljefedelrodeodeljefe pushed a commit that referenced this pull request May 24, 2016

doc: remove "\" within backticks

ed11ac6

Ref: #6911 Ref: #5075 PR-URL: #6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request May 30, 2016

doc: remove "\" within backticks

f515c6e

Ref: nodejs#6911 Ref: nodejs#5075 PR-URL: nodejs#6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

MylesBorins added dont-land-on-v4.x and removed lts-watch-v4.x labels Jun 1, 2016

rvagg pushed a commit that referenced this pull request Jun 2, 2016

doc: remove "\" within backticks

95f8d59

Ref: #6911 Ref: #5075 PR-URL: #6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

This was referenced Apr 24, 2023

[Snyk] Fix for 44 vulnerabilities aliscco/alisco-node#115

Open

[Snyk] Fix for 8 vulnerabilities aliscco/alisco-node#325

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: improvements to child_process, process docs #5075

doc: improvements to child_process, process docs #5075

estliberitas commented Feb 4, 2016

estliberitas Feb 4, 2016

jasnell Feb 4, 2016

cjihrig Feb 4, 2016

estliberitas commented Feb 10, 2016

estliberitas commented Feb 10, 2016

silverwind Feb 16, 2016

estliberitas Feb 16, 2016

sam-github commented Feb 18, 2016

sam-github Feb 18, 2016

estliberitas Feb 18, 2016

estliberitas Feb 18, 2016

jasnell commented Feb 19, 2016

jasnell commented Apr 2, 2016

eljefedelrodeodeljefe Apr 2, 2016

estliberitas Apr 2, 2016

eljefedelrodeodeljefe commented Apr 2, 2016

eljefedelrodeodeljefe commented Apr 3, 2016

estliberitas commented Apr 4, 2016

sam-github Apr 5, 2016

estliberitas Apr 7, 2016

estliberitas commented Apr 10, 2016

sam-github commented Apr 12, 2016

estliberitas commented Apr 14, 2016

jasnell commented Apr 21, 2016

silverwind commented Apr 21, 2016

estliberitas commented Apr 21, 2016

estliberitas commented Apr 22, 2016

jasnell commented Apr 22, 2016

MylesBorins commented Jun 1, 2016

doc: improvements to child_process, process docs #5075

doc: improvements to child_process, process docs #5075

Conversation

estliberitas commented Feb 4, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

estliberitas commented Feb 10, 2016

estliberitas commented Feb 10, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-github commented Feb 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Feb 19, 2016

jasnell commented Apr 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eljefedelrodeodeljefe commented Apr 2, 2016

eljefedelrodeodeljefe commented Apr 3, 2016

estliberitas commented Apr 4, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

estliberitas commented Apr 10, 2016

sam-github commented Apr 12, 2016

estliberitas commented Apr 14, 2016

jasnell commented Apr 21, 2016

silverwind commented Apr 21, 2016

estliberitas commented Apr 21, 2016

estliberitas commented Apr 22, 2016

jasnell commented Apr 22, 2016

MylesBorins commented Jun 1, 2016