aboutsummaryrefslogtreecommitdiff
path: root/src/os/job.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/os/job.h')
-rw-r--r--src/os/job.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/os/job.h b/src/os/job.h
index 37e34700dc..db147f2c24 100644
--- a/src/os/job.h
+++ b/src/os/job.h
@@ -28,7 +28,8 @@ void job_teardown(void);
/// on stdout
/// @param stderr_cb Callback that will be invoked when data is available
/// on stderr
-/// @param exit_cb Callback that will be invoked when the job exits
+/// @param exit_cb Callback that will be invoked when the job exits. This is
+/// optional.
/// @return The job id if the job started successfully. If the the first item /
/// of `argv`(the program) could not be executed, -1 will be returned.
// 0 will be returned if the job table is full.