From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Mon, 31 Jul 2017 18:08:19 +0000 (-0400)
Subject: Docs: document the lttng_action_notify action type
X-Git-Tag: v2.11.0-rc1~467
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=a109f1c6acc90b8ca847ebe2d68b67601e250541;p=lttng-tools.git

Docs: document the lttng_action_notify action type

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/include/lttng/action/notify.h b/include/lttng/action/notify.h
index 6c0d0ca25..04f468561 100644
--- a/include/lttng/action/notify.h
+++ b/include/lttng/action/notify.h
@@ -24,6 +24,17 @@ struct lttng_action;
 extern "C" {
 #endif
 
+/*
+ * Create a newly allocated notification action object.
+ *
+ * A "notify" action will emit a notification to all clients which have an
+ * open notification channel. In order to receive this notification, clients
+ * must have subscribed to a condition equivalent to the one paired to this
+ * notify action in a trigger.
+ *
+ * Returns a new action on success, NULL on failure. This action must be
+ * destroyed using lttng_action_destroy().
+ */
 extern struct lttng_action *lttng_action_notify_create(void);
 
 #ifdef __cplusplus