summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorMichał Zieliński <michal@zielinscy.org.pl>2014-02-27 19:48:53 +0100
committerMichał Zieliński <michal@zielinscy.org.pl>2014-02-27 19:52:04 +0100
commitf4371bfef85e5a1340de803d90ec176291094d0e (patch)
treec7be12c14386d62de95d17237fbb61341d784faa /lib
parent2b271e7b17a08e27b2fe961e93eebb3089461dbb (diff)
downloadNim-f4371bfef85e5a1340de803d90ec176291094d0e.tar.gz
osproc: add warning about using waitForExit without poParentStreams
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/osproc.nim3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/pure/osproc.nim b/lib/pure/osproc.nim
index 2a685f3fb..582b3c960 100644
--- a/lib/pure/osproc.nim
+++ b/lib/pure/osproc.nim
@@ -168,6 +168,9 @@ proc processID*(p: PProcess): int {.rtl, extern: "nosp$1".} =
 proc waitForExit*(p: PProcess, timeout: int = -1): int {.rtl,
   extern: "nosp$1", tags: [].}
   ## waits for the process to finish and returns `p`'s error code.
+  ##
+  ## **Warning**: Be careful when using waitForExit for processes created without
+  ## poParentStreams because they may fill output buffers, causing deadlock.
 
 proc peekExitCode*(p: PProcess): int {.tags: [].}
   ## return -1 if the process is still running. Otherwise the process' exit code