summaryrefslogtreecommitdiff
path: root/ext/pty/pty.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-06-23 08:12:54 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-06-23 08:12:54 +0000
commitc7d001465cdb2956b6d0804b1ab34104846275ce (patch)
treefc8b9a0d16a246fd19499c5ad24c389c046806b9 /ext/pty/pty.c
parent0de2d84af82935ba01ba1d3328c9fdcf287bf3e1 (diff)
* NEWS (ptr): new method and deprecated methods. [ruby-dev:41681]
* ext/pty/{README,README.ja}: ditto. * ext/pty/pty.c (pty_check): add rdoc. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28399 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/pty/pty.c')
-rw-r--r--ext/pty/pty.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/ext/pty/pty.c b/ext/pty/pty.c
index 9026daf..e212b49 100644
--- a/ext/pty/pty.c
+++ b/ext/pty/pty.c
@@ -606,6 +606,15 @@ raise_from_check(pid_t pid, int status)
rb_exc_raise(exc);
}
+/*
+ * call-seq:
+ * PTY.check(pid[, raise=false]) => Process::Status or nil
+ *
+ * checks the status of the child process specified by _pid_, and
+ * returns +nil+ if the process is still alive and active. Otherwise,
+ * returns +Process::Status+ about the process if _raise_ is false, or
+ * +PTY::ChildExited+ exception is raised.
+ */
static VALUE
pty_check(int argc, VALUE *argv, VALUE self)
{