Clarify Process::wait() callback behaviour

Lilchef · xabbuh · commit d696a15c29ef · 2016-11-05T11:33:18.000+01:00
diff --git a/components/process.rst b/components/process.rst
@@ -113,7 +113,24 @@ are done doing other stuff::
     $process->start();
 
     // ... do other things
+    
+    $process->wait();
+    
+    // ... do things after the process has finished
 
+.. note::
+
+    The :method:`Symfony\\Component\\Process\\Process::wait` method is blocking,
+    which means that your code will halt at this line until the external
+    process is completed.
+
+:method:`Symfony\\Component\\Process\\Process::wait` takes one optional argument:
+a callback that is called repeatedly whilst the process is still running, passing
+in the output and its type::
+
+    $process = new Process('ls -lsa');
+    $process->start();
+    
     $process->wait(function ($type, $buffer) {
         if (Process::ERR === $type) {
             echo 'ERR > '.$buffer;
@@ -122,12 +139,6 @@ are done doing other stuff::
         }
     });
 
-.. note::
-
-    The :method:`Symfony\\Component\\Process\\Process::wait` method is blocking,
-    which means that your code will halt at this line until the external
-    process is completed.
-
 Stopping a Process
 ------------------
 
