Skip to content

Commit d371f08

Browse files
committed
Update docs
1 parent d66f8a1 commit d371f08

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ $command->setStdIn('string');
9393
PHP working dir.
9494
* `$procEnv`: An array with environment variables to pass to `proc_open()`. Default is `null` for none.
9595
* `$procOptions`: An array of `other_options` for `proc_open()`. Default is `null` for none.
96-
* `$nonBlockingMode`: Whether to set the stdout/stderr streams to non-blocking
97-
mode when `proc_open()` is used. This can fix issues with long running
98-
commands that hang indefinitely but can cause problems on Windows systems.
99-
The default is `null` in which case non-blocking mode is only enabled on
100-
non-Windows systems.
96+
* `$nonBlockingMode`: Whether to set the stdin/stdout/stderr streams to non-blocking
97+
mode when `proc_open()` is used. This allows to have huge inputs/outputs
98+
without making the process hang. The default is `null` which will enable
99+
the feature on Non-Windows systems. Set it to `true` or `false` to manually
100+
enable/disable it. Note that it doesn't work on Windows.
101101
* `$locale`: The locale to (temporarily) set with `setlocale()` before running the command.
102102
This can be set to e.g. `en_US.UTF-8` if you have issues with UTF-8 encoded arguments.
103103

src/Command.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ class Command
5454
public $procOptions;
5555

5656
/**
57-
* @var bool|null whether to set the stdout/stderr streams to non-blocking mode
58-
* when `proc_open()` is used. This can fix issues with long running
59-
* commands that hang indefinitely but can cause problems on Windows
60-
* systems. The default is `null` in which case non-blocking mode is only
61-
* enabled on non-Windows systems.
57+
* @var bool|null whether to set the stdin/stdout/stderr streams to
58+
* non-blocking mode when `proc_open()` is used. This allows to have huge
59+
* inputs/outputs without making the process hang. The default is `null`
60+
* which will enable the feature on Non-Windows systems. Set it to `true`
61+
* or `false` to manually enable/disable it. It does not work on Windows.
6262
*/
6363
public $nonBlockingMode;
6464

0 commit comments

Comments
 (0)