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

lttng-untrack(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: Ibafe1662e37110962ae3c7fdef9d450b75f2c0a5
---

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index 28cb1bfcf..771c5e69c 100644
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -1,6 +1,6 @@
 lttng-untrack(1)
 ================
-:revdate: 1 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -52,6 +52,7 @@ recording event rules.
 The `untrack` command removes values from _inclusion sets_ of process
 attributes. See man:lttng-track(1) to learn more about inclusion sets.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
 
 
 Inclusion set example
@@ -243,6 +244,41 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Remove the PIDs 1728 and 3775 from the Linux kernel process ID inclusion set of the current tracing session.
+====
+See the option:--pid option.
+
+[role="term"]
+----
+$ lttng untrack --kernel --pid=1728,3775
+----
+====
+
+.Remove the IDs of a specific groups from the user space virtual group ID inclusion set of a specific tracing session.
+====
+See the option:--vgid and option:--session options.
+
+[role="term"]
+----
+$ lttng untrack --userspace --session=my-session \
+                --vgid=docker,mysql
+----
+====
+
+.Remove all the user IDs from the Linux kernel user ID inclusion set of the current tracing session.
+====
+See the option:--all and option:--uid options.
+
+[role="term"]
+----
+$ lttng untrack --kernel --all --uid
+----
+====
+
+
 include::common-footer.txt[]