#DOCUMENTATION by Maren
authormatilk
Thu, 23 Feb 2017 10:58:09 +0100
changeset 21552 7732a5719d14
parent 21551 a00b3ea45664
child 21553 bd94215744c9
#DOCUMENTATION by Maren class: OSProcess comment/format in: #auxStream: #documentation #execute #finishSema #isAlive #isDead #setupShufflerForInput: #terminateGroup various spelling fixes
OSProcess.st
--- a/OSProcess.st	Thu Feb 23 10:47:47 2017 +0100
+++ b/OSProcess.st	Thu Feb 23 10:58:09 2017 +0100
@@ -15,7 +15,7 @@
 
 documentation
 "
-    Instances of OSProcess represent operating system processes thatr can be executed.
+    Instances of OSProcess represent operating system processes that can be executed.
     (as opposed to Smalltalk processes).
 
     [author:]
@@ -121,10 +121,12 @@
 !
 
 auxStream:something
-    "set an auxilliary input stream that will be available to the command as
+    "set an auxiliary input stream that will be available to the command as
      file descriptor 3"
 
     auxStream := something.
+
+    "Modified (comment): / 23-02-2017 / 10:56:57 / Maren"
 !
 
 command
@@ -202,10 +204,12 @@
 !
 
 finishSema
-    "wait on this semaphore if yo want to wait until the os process has finished.
+    "wait on this semaphore if you want to wait until the OS process has finished.
      There may be multiple waiters, so it is a good idea to do a #waitUncounted"
 
     ^ finishSema
+
+    "Modified (comment): / 23-02-2017 / 10:53:17 / Maren"
 !
 
 inStream
@@ -325,7 +329,7 @@
 
 setupShufflerForInput:aStream
     "if aStream is an internal Stream, set up a pipe for the command input.
-     Start a process that shuffles tha data fron the internal stream into the pipe
+     Start a process that shuffles the data from the internal stream into the pipe
      (and into the command's input)."
 
     |pipe externalStream shuffledStream shufflerProcess|
@@ -378,6 +382,7 @@
     ^ externalStream
 
     "Modified: / 31-01-2017 / 16:50:39 / stefan"
+    "Modified (comment): / 23-02-2017 / 10:51:34 / Maren"
 !
 
 setupShufflerForOutput:aStream
@@ -438,24 +443,28 @@
 !
 
 isAlive
-    "answer true, if the process is still alive"
+    "answer true if the process is still alive"
 
     ^ pid notNil and:[exitStatus isNil]
+
+    "Modified (comment): / 23-02-2017 / 10:52:37 / Maren"
 !
 
 isDead
-    "answer true, if the process is no longer alive"
+    "answer true if the process is no longer alive"
 
     ^ self isAlive not
+
+    "Modified (comment): / 23-02-2017 / 10:52:31 / Maren"
 ! !
 
 !OSProcess methodsFor:'starting'!
 
 execute
     "execute the command. 
-     Wait until is is finished.
+     Wait until it is finished.
      Abort the execution if I am interrupted.
-     Answer true if the terminated succesfully, 
+     Answer true if it terminated successfully, 
      false if it could not be started or terminated with error."
 
     |ok|
@@ -474,6 +483,8 @@
         ].
     ].
     ^ ok.
+
+    "Modified (comment): / 23-02-2017 / 10:54:34 / Maren"
 !
 
 startProcess
@@ -577,7 +588,7 @@
 
 terminateGroup
     "terminate the process group.
-     Under Windows, this is the same as terminateWithhAllChildren,
+     Under Windows, this is the same as terminateWithAllChildren,
      under unix, this terminates a subset of all children"
 
     pid notNil ifTrue:[
@@ -586,7 +597,7 @@
             terminateProcess:pid.
     ].
 
-    "Modified (comment): / 23-02-2017 / 10:46:27 / Maren"
+    "Modified (comment): / 23-02-2017 / 10:50:13 / Maren"
 ! !
 
 !OSProcess methodsFor:'waiting'!