From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 20:05:40 +0000 (-0400)
Subject: lttng-stop(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=4182cfea302ab5c0233d45433e7dc85697c4016d;p=lttng-tools.git

lttng-stop(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: I6794937457d4f34d649b9edb6a755e091a6af67e
---

diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt
index 9b1907c61..d0371c74d 100644
--- a/doc/man/lttng-stop.1.txt
+++ b/doc/man/lttng-stop.1.txt
@@ -1,6 +1,6 @@
 lttng-stop(1)
 =============
-:revdate: 29 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -52,6 +52,8 @@ remains inactive, it's :not: a trace chunk archive: you need to destroy
 the tracing session with man:lttng-destroy(1) or perform a rotation with
 man:lttng-rotate(1) to archive it.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -67,6 +69,36 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Stop the current tracing session.
+====
+[role="term"]
+----
+$ lttng stop
+----
+====
+
+.Stop a specific tracing session.
+====
+[role="term"]
+----
+$ lttng stop my-session
+----
+====
+
+.Stop the current tracing session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng stop --no-wait
+----
+====
+
+
 include::common-footer.txt[]