From 0659e8baf25c86cadac8cac79f4e800501694c8b Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Sun, 29 Jun 2014 20:18:01 -0400 Subject: [PATCH] shared/util.c:wait_for_terminate_and_warn(): Add a comment on the return values --- src/shared/util.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/shared/util.c b/src/shared/util.c index af6bde2c3..e75f6c9df 100644 --- a/src/shared/util.c +++ b/src/shared/util.c @@ -3482,6 +3482,17 @@ int wait_for_terminate(pid_t pid, siginfo_t *status) { } } +/* + * Return values: + * < 0 : wait_for_terminate() failed to get the state of the + * process, the process was terminated by a signal, or + * failed for an unknown reason. + * >=0 : The process terminated normally, and its exit code is + * returned. + * + * That is, success is indicated by a return value of zero, and an + * error is indicated by a non-zero value. + */ int wait_for_terminate_and_warn(const char *name, pid_t pid) { int r; siginfo_t status; -- 2.30.2