From 42969a5fd3d640d13f565dc60744282806412b36 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 15:46:22 -0400 Subject: [PATCH] lttng-rotate(1): add usage examples MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau Change-Id: I2ee1a32fd44b6abf6a8d58749f1a42731b30ba56 --- doc/man/lttng-rotate.1.txt | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) 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 <> 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[] -- 2.34.1