From: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Date: Tue, 6 Sep 2016 18:21:11 +0000 (-0400)
Subject: Fix: wrong api comments for load.h
X-Git-Tag: v2.8.2~6
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=9fb47611183e44184f264fa2196186e59ee31ef0;p=lttng-tools.git

Fix: wrong api comments for load.h

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/include/lttng/load.h b/include/lttng/load.h
index 815529835..6b7d68339 100644
--- a/include/lttng/load.h
+++ b/include/lttng/load.h
@@ -41,15 +41,15 @@ void lttng_load_session_attr_destroy(struct lttng_load_session_attr *attr);
 
 
 /*
- * Save session attribute getter family functions.
+ * Load session attribute getter family functions.
  */
 
-/* Return session name. NULL indicated all sessions must be loadd. */
+/* Return session name. NULL indicated all sessions must be loaded. */
 const char *lttng_load_session_attr_get_session_name(
 	struct lttng_load_session_attr *attr);
 /*
- * Return destination URL. A NULL value indicates the default session
- * configuration location. The URL format used is documented in lttng(1).
+ * Return input URL. A NULL value indicates the default session
+ * configuration location. The URL format used is documented in lttng-create(1).
  * NULL indicates that the default session configuration path is used.
  */
 const char *lttng_load_session_attr_get_input_url(
@@ -57,13 +57,15 @@ const char *lttng_load_session_attr_get_input_url(
 
 /*
  * Return the configuration overwrite attribute. This attribute indicates
- * whether or not existing configuration files must be overwritten.
+ * whether or not the loaded session is loaded even if a session with the same
+ * name already exist. If so the existing session is deleted before the
+ * replacement is loaded.
  */
 int lttng_load_session_attr_get_overwrite(
 	struct lttng_load_session_attr *attr);
 
 /*
- * Save session attribute setter family functions.
+ * Load session attribute setter family functions.
  *
  * For every set* call, 0 is returned on success or else -LTTNG_ERR_INVALID is
  * returned indicating that at least one given parameter is invalid.
@@ -71,7 +73,7 @@ int lttng_load_session_attr_get_overwrite(
 
 /*
  * Set the name of the session to load. A NULL name means all sessions
- * known to the session daemon will be loadd.
+ * known to the session daemon will be loaded.
  */
 int lttng_load_session_attr_set_session_name(
 	struct lttng_load_session_attr *attr, const char *session_name);
@@ -86,14 +88,14 @@ int lttng_load_session_attr_set_input_url(
 	struct lttng_load_session_attr *attr, const char *url);
 
 /*
- * Set the overwrite attribute. If set to true, files of the same name as the
- * current session configuration URL will be overwritten.
+ * Set the overwrite attribute. If set to true, current session matching the
+ * loaded sessions will be deleted and the loaded sessions created.
  */
 int lttng_load_session_attr_set_overwrite(
 	struct lttng_load_session_attr *attr, int overwrite);
 
 /*
- * Save session configuration(s).
+ * Load session configuration(s).
  *
  * The lttng_load_session_attr object must not be NULL. No ownership of the
  * object is kept by the function; it must be released by the caller.