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

lttng-regenerate(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: I91074dfc717d481fe16ec4f40533757a0b3f3da4
---

diff --git a/doc/man/lttng-regenerate.1.txt b/doc/man/lttng-regenerate.1.txt
index cd8f4d776..7e4476007 100644
--- a/doc/man/lttng-regenerate.1.txt
+++ b/doc/man/lttng-regenerate.1.txt
@@ -1,6 +1,6 @@
 lttng-regenerate(1)
 ===================
-:revdate: 30 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -37,6 +37,8 @@ See man:lttng-concepts(7) to learn more about tracing sessions.
 As of this version, the `metadata` and `statedump` targets are
 available.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 Regenerate the metadata of a tracing session
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -99,6 +101,28 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Regenerate the metadata of the current tracing session.
+====
+[role="term"]
+----
+$ lttng regenerate metadata
+----
+====
+
+.Regenerate the state dump event records of a specific tracing session.
+====
+See the option:--session option.
+
+[role="term"]
+----
+$ lttng regenerate statedump --session=my-session
+----
+====
+
+
 include::common-footer.txt[]