Skip to content

doc: document that 'ipc' is required with fork stdio option - #8290

Closed
jasnell wants to merge 3 commits into
nodejs:masterfrom
jasnell:doc-fork-stdio
Closed

doc: document that 'ipc' is required with fork stdio option#8290
jasnell wants to merge 3 commits into
nodejs:masterfrom
jasnell:doc-fork-stdio

Conversation

@jasnell

@jasnelljasnell commented Aug 27, 2016

Copy link
Copy Markdown
Member
Checklist
  • make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

document that 'ipc' is required with fork stdio option

Fixes: #8167

@jasnelljasnell added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Aug 27, 2016
cjihrig
cjihrig reviewed Aug 27, 2016
View reviewed changes
Comment threaddoc/api/child_process.md Outdated
environment variable `NODE_CHANNEL_FD` on the child process. The input and
output on this fd is expected to be line delimited JSON objects.

When specifying the [`stdio`][] option, the value *must* be a JSON Array

@cjihrigcjihrigAug 27, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSON Array -> array

@cjihrig

cjihrig commented Aug 27, 2016

Copy link
Copy Markdown
Contributor

I would just add this into the existing fork()stdio documentation, instead of creating a new paragraph, but I don't feel really strongly about it.

@jasnell

jasnell commented Aug 27, 2016

Copy link
Copy Markdown
MemberAuthor

Fixed with exactly. I'd rather keep this with the fork method given that it's where this error is most likely to be seen.

@cjihrig

cjihrig commented Aug 27, 2016

Copy link
Copy Markdown
Contributor

Yea, the fork() method has its own documentation for stdio :-)

@jasnell

jasnell commented Aug 27, 2016

Copy link
Copy Markdown
MemberAuthor

oh.. you mean up in the options list?

@cjihrig

cjihrig commented Aug 27, 2016

Copy link
Copy Markdown
Contributor

Yea, but I won't fight the existing approach.

@jasnell

jasnell commented Aug 27, 2016

Copy link
Copy Markdown
MemberAuthor

heh... I can do that. I thought you meant moving it down into the more extensive documentation under spawn

@cjihrig

cjihrig commented Aug 27, 2016

Copy link
Copy Markdown
Contributor

LGTM

1 similar comment
@benjamingr

benjamingr commented Aug 28, 2016

Copy link
Copy Markdown
Member

LGTM

jasnell added a commit that referenced this pull request Aug 29, 2016
@jasnell
doc: 'ipc' is required with fork stdio option
f10e1ed
Fixes: #8167
PR-URL: #8290
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@jasnell

jasnell commented Aug 29, 2016

Copy link
Copy Markdown
MemberAuthor

Landed in f10e1ed

@jasnelljasnell closed this Aug 29, 2016
@Fishrock123Fishrock123 mentioned this pull request Sep 6, 2016
Closed
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Sep 8, 2016
@jasnell@Fishrock123
doc: 'ipc' is required with fork stdio option
ca0fe5d
Fixes: nodejs#8167
PR-URL: nodejs#8290
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Fishrock123 pushed a commit that referenced this pull request Sep 9, 2016
@jasnell@Fishrock123
doc: 'ipc' is required with fork stdio option
48be8bc
Fixes: #8167
PR-URL: #8290
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

child_processIssues and PRs related to the child_process subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jasnell@cjihrig@benjamingr@MylesBorins