/*
* The lttng_load_session_attr object is opaque to the user. Use the helper
- * functions below to use them.
+ * functions below to use it.
*/
struct lttng_load_session_attr;
/*
- * Load session attribute getter family functions.
+ * Load session attribute getter family of functions.
*/
-/* Return session name. NULL indicated all sessions must be loaded. */
+/* Return session name. NULL indicates all sessions must be loaded. */
const char *lttng_load_session_attr_get_session_name(
struct lttng_load_session_attr *attr);
/*
/*
* Return the configuration overwrite attribute. This attribute indicates
- * 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.
+ * whether or not the loaded session should be loaded even if a session with the
+ * same name already exists. If such a session exists, it is destroyed before
+ * the replacement is loaded.
*/
int lttng_load_session_attr_get_overwrite(
struct lttng_load_session_attr *attr);
/*
- * Load session attribute setter family functions.
+ * Load session attribute setter family of 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.
/*
* Set the name of the session to load. A NULL name means all sessions
- * known to the session daemon will be loaded.
+ * found at the input URL will be loaded.
*/
int lttng_load_session_attr_set_session_name(
struct lttng_load_session_attr *attr, const char *session_name);
/*
* Set the URL of the session configuration to load. A NULL value indicates the
- * use of the default location being the session one.
+ * use of the default session configuration location.
*
* Note that file:// is the only supported URL format.
*/
struct lttng_load_session_attr *attr, const char *url);
/*
- * Set the overwrite attribute. If set to true, current session matching the
- * loaded sessions will be deleted and the loaded sessions created.
+ * Set the overwrite attribute. If set to true, current sessions matching the
+ * loaded sessions will be destroyed and the replaced by the sessions being
+ * loaded.
*/
int lttng_load_session_attr_set_overwrite(
struct lttng_load_session_attr *attr, int overwrite);