From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 18:04:21 +0000 (-0400)
Subject: lttng-clear(1): add usage examples
X-Git-Tag: v2.13.0-rc3~113
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=0715718480d432a198e48272a0a580bdb4be265d;p=lttng-tools.git

lttng-clear(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: Id410c79fddb88de87edda333bec9ef59b6f5afc9
---

diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt
index 4fb52671a..a74bee0ed 100644
--- a/doc/man/lttng-clear.1.txt
+++ b/doc/man/lttng-clear.1.txt
@@ -1,6 +1,6 @@
 lttng-clear(1)
 ==============
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 NAME
 ----
@@ -54,6 +54,8 @@ man:lttng-relayd(8) can disable remote clearing operations. If LTTng
 sends tracing data over the network for the selected tracing session(s)
 to an LTTng relay daemon configured as such, the `clear` command fails.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -73,6 +75,36 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Clear the current tracing session.
+====
+[role="term"]
+----
+$ lttng clear
+----
+====
+
+.Clear a specific tracing session.
+====
+[role="term"]
+----
+$ lttng clear my-session
+----
+====
+
+.Clear all tracing sessions.
+====
+See the option:--all option.
+
+[role="term"]
+----
+$ lttng clear --all
+----
+====
+
+
 include::common-footer.txt[]