Skip to content

Commit

Permalink
doc: copyedit maxBuffer note for child_process
Browse files Browse the repository at this point in the history
PR-URL: #6760
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
Trott authored and evanlucas committed May 17, 2016
1 parent c1bf3fc commit 897934a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1040,9 +1040,9 @@ to the same value.
## `maxBuffer` and Unicode

It is important to keep in mind that the `maxBuffer` option specifies the
largest number of *octets* allowed on `stdout` or `stderr` - if this value is
exceeded then the child process is terminated. This particularly impacts
output that includes multi-byte character encodings such as UTF-8 or UTF-16.
largest number of *octets* allowed on `stdout` or `stderr`. If this value is
exceeded, then the child process is terminated. This particularly impacts
output that includes multibyte character encodings such as UTF-8 or UTF-16.
For instance, the following will output 13 UTF-8 encoded octets to `stdout`
although there are only 4 characters:

Expand Down

0 comments on commit 897934a

Please sign in to comment.