From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 19:46:22 +0000 (-0400)
Subject: lttng-rotate(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=42969a5fd3d640d13f565dc60744282806412b36;p=lttng-tools.git

lttng-rotate(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: I2ee1a32fd44b6abf6a8d58749f1a42731b30ba56
---

diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt
index 29ff3a0d7..2a73f8bcf 100644
--- a/doc/man/lttng-rotate.1.txt
+++ b/doc/man/lttng-rotate.1.txt
@@ -1,6 +1,6 @@
 lttng-rotate(1)
 ===============
-:revdate: 30 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -62,6 +62,8 @@ directly cause discarded event records or packets.
 A `rotate-session` trigger action can also rotate a tracing session (see
 man:lttng-add-trigger(1)).
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 [IMPORTANT]
 ====
 You may only use the `rotate` command when:
@@ -93,6 +95,36 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Rotate the current tracing session.
+====
+[role="term"]
+----
+$ lttng rotate
+----
+====
+
+.Rotate a specific tracing session.
+====
+[role="term"]
+----
+$ lttng rotate my-session
+----
+====
+
+.Rotate the current tracing session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng rotate --no-wait
+----
+====
+
+
 include::common-footer.txt[]