X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fsession.h;h=22419cbe726dc591e79bf1b15836183e5ffba4ef;hb=af0c0d75dd996dbf21bda2c8364f35c1e2ef7f0a;hp=599892d13508d7470f829f6c89da84b18aea6b9c;hpb=d685c8c6e082402837b23be4ad81d9cae59a8a3b;p=lttng-tools.git

diff --git a/include/lttng/session.h b/include/lttng/session.h
index 599892d13..22419cbe7 100644
--- 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;