From: Julien Desfossez <jdesfossez@efficios.com>
Date: Mon, 7 Mar 2016 19:21:30 +0000 (-0500)
Subject: Document the live detach command
X-Git-Tag: v2.8.0-rc1~69
X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=2bedf84846826ef5c4e1c198ea04d7ebd96201f8

Document the live detach command

Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/doc/live-reading-protocol.txt b/doc/live-reading-protocol.txt
index 7bf230f50..251f27c2c 100644
--- a/doc/live-reading-protocol.txt
+++ b/doc/live-reading-protocol.txt
@@ -145,3 +145,9 @@ When new metadata is added during a session, the GET_NEXT_INDEX will succeed
 but it will have the flag LTTNG_VIEWER_FLAG_NEW_METADATA, but the
 GET_DATA_PACKET will fail with the same flag as long as the metadata is not
 downloaded.
+
+Detach from a session:
+Closing the network connection detaches a client from all the sessions it is
+currently attached to. It is also possible to detach from a specific session
+without disconnecting by sending the LTTNG_VIEWER_DETACH_SESSION command. The
+payload of this command is the session ID.