Docs: document the format of the lttng_session path member

[lttng-tools.git] / include / lttng / session.h

diff --git a/include/lttng/session.h b/include/lttng/session.h
index 599892d13508d7470f829f6c89da84b18aea6b9c..e626b00814ea1fec171a7d508d8d3495c0ea950a 100644 (file)
--- a/include/lttng/session.h
+++ b/include/lttng/session.h
@@ -33,7 +33,15 @@ extern "C" {
 #define LTTNG_SESSION_PADDING1             12
 struct lttng_session {
        char name[LTTNG_NAME_MAX];
-       /* The path where traces are written */
+       /*
+        * Human-readable representation of the trace's destination.
+        * In the case of a local tracing session, a path is provided:
+        *     /path/to/the/output
+        *
+        * In the case of a remote (network) tracing session, the string has
+        * the following format:
+        *     net://hostname/path:ctrl_port [data: data_port]
+        */
        char path[PATH_MAX];
        uint32_t enabled;       /* enabled/started: 1, disabled/stopped: 0 */
        uint32_t snapshot_mode;
@@ -76,8 +84,7 @@ extern int lttng_create_session_snapshot(const char *name,
  * indexes are sent and metadata is checked for each packet.
  *
  * Name can't be NULL. If no URL is given, the default is to send the data to
- * net://127.0.0.1. The timer_interval is in usec and by default set to 1000000
- * (1 second).
+ * net://127.0.0.1. The timer_interval is in usec.
  *
  * Return 0 on success else a negative LTTng error code.
  */