X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Fsession.h;h=e626b00814ea1fec171a7d508d8d3495c0ea950a;hp=91566e2845d452b6ad3bfab093a0c234db5ac575;hb=beede00c4c60130c7689231b2dd4cb61a6aae34f;hpb=1aacaae2baa854d47e2d80c0bc2c50c31eb2202a

diff --git a/include/lttng/session.h b/include/lttng/session.h
index 91566e284..e626b0081 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;