From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 18:04:53 +0000 (-0400)
Subject: lttng-disable-channel(1): add usage examples
X-Git-Tag: v2.13.0-rc3~110
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=3f48387078d7800a7151ed28db5f79ae6535c7a8;p=lttng-tools.git

lttng-disable-channel(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: Ia524f1e3f032633670312000f4fc5674c09da498
---

diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt
index 7f86d6d18..b25ea3c28 100644
--- a/doc/man/lttng-disable-channel.1.txt
+++ b/doc/man/lttng-disable-channel.1.txt
@@ -1,6 +1,6 @@
 lttng-disable-channel(1)
 ========================
-:revdate: 29 April 2021
+:revdate: 17 May 2021
 
 NAME
 ----
@@ -36,6 +36,8 @@ As of LTTng{nbsp}{lttng_version}, you may :not: enable a disabled
 channel once its tracing session has ben started (see
 man:lttng-start(1)) at least once.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -64,6 +66,29 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Disable one Linux kernel channel of the current tracing session.
+====
+[role="term"]
+----
+$ lttng disable-channel --kernel my-channel
+----
+====
+
+.Disable two user space channels of a specific tracing session.
+====
+See the option:--session option.
+
+[role="term"]
+----
+$ lttng disable-channel --kernel --session=my-session \
+                        little,box
+----
+====
+
+
 include::common-footer.txt[]