summaryrefslogtreecommitdiff
path: root/src/sd-daemon.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/sd-daemon.h')
-rw-r--r--src/sd-daemon.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/src/sd-daemon.h b/src/sd-daemon.h
index 0277b0fb5c..2d79082aa3 100644
--- a/src/sd-daemon.h
+++ b/src/sd-daemon.h
@@ -126,9 +126,9 @@ int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t
* little value in signalling non-readiness the only
* value daemons should send is "READY=1".
*
- * STATUS=... Passes a status string back to systemd that
- * describes the daemon state. This is free-from and
- * can be used for various purposes: general state
+ * STATUS=... Passes a single-line status string back to systemd
+ * that describes the daemon state. This is free-from
+ * and can be used for various purposes: general state
* feedback, fsck-like programs could pass completion
* percentages and failing programs could pass a human
* readable error message. Example: "STATUS=Completed
@@ -143,6 +143,12 @@ int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t
* MAINPID=... The main pid of a daemon, in case systemd did not
* fork off the process itself. Example: "MAINPID=4711"
*
+ * Daemons can choose to send additional variables.
+ *
+ * Returns a negative errno-style error code on failure. Returns > 0
+ * if systemd could be notified, 0 if it couldn't possibly because
+ * systemd is not running.
+ *
* See sd_notifyf() for more complete examples.
*/
int sd_notify(int unset_environment, const char *state);