Add warning to osproc.close

This commit is contained in:
Dominik Picheta
2016-07-21 16:14:00 +01:00
committed by GitHub
parent cf8ee366d1
commit 5784e43662

View File

@@ -175,7 +175,11 @@ proc startCmd*(command: string, options: set[ProcessOption] = {
result = startProcess(command=command, options=options + {poEvalCommand})
proc close*(p: Process) {.rtl, extern: "nosp$1", tags: [].}
## When the process has finished executing, cleanup related handles
## When the process has finished executing, cleanup related handles.
##
## **Warning:** If the process has not finished executing, this will forcibly
## terminate the process. Doing so may result in zombie processes and
## `pty leaks <http://stackoverflow.com/questions/27021641/how-to-fix-request-failed-on-channel-0>`_.
proc suspend*(p: Process) {.rtl, extern: "nosp$1", tags: [].}
## Suspends the process `p`.