From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 18:04:43 +0000 (-0400)
Subject: lttng-destroy(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=4e08556fefc5facc8ca0c08e5d332d1648db2d8e;p=lttng-tools.git

lttng-destroy(1): add usage examples

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: If16dcd4197c6af734b1147c9463ae2255b0a1c1f
---

diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt
index 979292477..7ab13a7f6 100644
--- a/doc/man/lttng-destroy.1.txt
+++ b/doc/man/lttng-destroy.1.txt
@@ -1,6 +1,6 @@
 lttng-destroy(1)
 ================
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -64,6 +64,8 @@ Then all the subdirectories of the output directory of{nbsp}__TS__
 command exits. In other words, it's safe to read them, modify them, move
 them, or remove then.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -85,6 +87,46 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Destroy the current tracing session.
+====
+[role="term"]
+----
+$ lttng destroy
+----
+====
+
+.Destroy the current tracing session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng destroy --no-wait
+----
+====
+
+.Destroy a specific tracing session.
+====
+[role="term"]
+----
+$ lttng destroy my-session
+----
+====
+
+.Destroy all tracing sessions.
+====
+See the option:--all option.
+
+[role="term"]
+----
+$ lttng destroy --all
+----
+====
+
+
 include::common-footer.txt[]