Permalink
Browse files

Added clarifying comments around process API.

  • Loading branch information...
1 parent 904bd29 commit 527b3ef501b83ef4d98a59bd654de9b3a23b9bb9 @wayneeseguin wayneeseguin committed May 15, 2014
Showing with 10 additions and 0 deletions.
  1. +10 −0 core/api/shell/process/functions
View
10 core/api/shell/process/functions
@@ -4,8 +4,18 @@
# SM Process API
#
# process start name <name> timeout <timeout> command <command> [params...]
+# Where timeout in start is the timeout to watch the process to ensure the
+# process stays running and then write a pidfile or return error if process
+# is no longer running.
+#
# process stop name <name> timeout <timeout>
+# Timeout in stop is the amount of time in seconds to wait for a process to
+# stop gracefully before sending SIGKILL.
+#
# process is running name <name>
+# returns 0 if the named process (via process start name ) is running and
+# returns 1 if the process is not found running.
+#
# process restart name <name> timeout_start <timeout> timeout_stop <timeout> command <command> [params...]
# process status <pid>
# process lock </path/to/myprocess.lock>

0 comments on commit 527b3ef

Please sign in to comment.