Skip to content

Commit 37569cd

Browse files
sam-githubpiscisaureus
authored andcommitted
doc: document the fds behind stdin/out/err
Its common knowledge on unix, but node documentation depends on knowing this, as it exposes both streams named after stdio, and the fd numbers, so make this explicit. Fixes: nodejs/node-v0.x-archive#8624 PR-URL: nodejs/node-v0.x-archive#8454 Reviewed-by: Trevor Norris <[email protected]> Cherry-picked-from: nodejs/node-v0.x-archive@13a992b
1 parent d8d1c4c commit 37569cd

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/process.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ emulation with `process.kill()`, and `child_process.kill()`:
172172

173173
## process.stdout
174174

175-
A `Writable Stream` to `stdout`.
175+
A `Writable Stream` to `stdout` (on fd `1`).
176176

177177
Example: the definition of `console.log`
178178

@@ -207,7 +207,7 @@ See [the tty docs](tty.html#tty_tty) for more information.
207207

208208
## process.stderr
209209

210-
A writable stream to stderr.
210+
A writable stream to stderr (on fd `2`).
211211

212212
`process.stderr` and `process.stdout` are unlike other streams in Node in
213213
that they cannot be closed (`end()` will throw), they never emit the `finish`
@@ -222,7 +222,7 @@ event and that writes are usually blocking.
222222

223223
## process.stdin
224224

225-
A `Readable Stream` for stdin.
225+
A `Readable Stream` for stdin (on fd `0`).
226226

227227
Example of opening standard input and listening for both events:
228228

0 commit comments

Comments
 (0)