Rename "tracing session" -> "recording session"

[lttng-tools.git] / doc / man / lttng-disable-rotation.1.txt

diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt
index 1a9e14ef06aea4a0c2477e4053f0ca261750d397..d719072e05aa395b2a335d4f2d269afb266f8d9c 100644 (file)
--- a/doc/man/lttng-disable-rotation.1.txt
+++ b/doc/man/lttng-disable-rotation.1.txt
@@ -1,73 +1,95 @@
 lttng-disable-rotation(1)
 =========================
+:revdate: 14 June 2021
 
 
 NAME
 ----
-lttng-disable-rotation - Unset a tracing session's automatic rotation schedule
+lttng-disable-rotation - Unset an LTTng recording session rotation schedule
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-rotation* (option:--timer | option:--size)
-      [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-rotation* [option:--session='SESSION']
+      (option:--timer | option:--size | option:--timer option:--size)
 
 
 DESCRIPTION
 -----------
-The `lttng disable-rotation` command unsets an automatic rotation
-schedule for the current tracing session, or for the tracing session
-named 'SESSION' if provided, previously set with the
-man:lttng-enable-rotation(1) command.
+The `lttng disable-rotation` command unsets a rotation schedule,
+previously set with the man:lttng-enable-rotation(1) command, for:
 
+With the option:--session='SESSION' option::
+    The recording session named 'SESSION'.
 
-include::common-cmd-options-head.txt[]
+Without the option:--session option::
+    The current recording session (see man:lttng-concepts(7) to learn
+    more about the current recording session).
 
+See man:lttng-concepts(7) to learn more about the recording session
+rotation and trace chunk concepts.
 
-Automatic rotation schedule condition
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-One of:
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
 
+
+include::common-lttng-cmd-options-head.txt[]
+
+
+Rotation schedule condition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 option:--size::
-    Unset the automatic rotation schedule previously set with the
-    nloption:--size option of the man:lttng-enable-rotation(1) command.
+    Unset the rotation schedule previously set with the nloption:--size
+    option of the man:lttng-enable-rotation(1) command.
 
 option:--timer::
-    Unset the automatic rotation schedule previously set with the
-    nloption:--timer option of the man:lttng-enable-rotation(1) command.
+    Unset the rotation schedule previously set with the nloption:--timer
+    option of the man:lttng-enable-rotation(1) command.
 
 
-Target
-~~~~~~
+Recording target
+~~~~~~~~~~~~~~~~
 option:-s 'SESSION', option:--session='SESSION'::
-    Unset an automatic rotation schedule in the tracing session named
-    'SESSION' instead of the current tracing session.
+    Unset a rotation schedule for the recording session named 'SESSION'
+    instead of the current recording session.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
 
 
-[[limitations]]
-LIMITATIONS
------------
-The `lttng enable-rotation` command only works when:
+include::common-lttng-cmd-after-options.txt[]
 
-* The tracing session is created in normal mode or in network streaming
-  mode (see man:lttng-create(1)).
 
-* No channel was created with a configured trace file count or size
-  limit (see the nloption:--tracefile-size and
-  nloption:--tracefile-count options in man:lttng-enable-channel(1)).
+[[examples]]
+EXAMPLES
+--------
+.Unset the size-based rotation schedule of the current recording session.
+====
+See the option:--size option.
 
-For a given tracing session, LTTng only performs an automatic rotation
-when no other rotation is currently happening.
+[role="term"]
+----
+$ lttng disable-rotation --size
+----
+====
+
+.Unset the periodic rotation schedule of a specific recording session.
+====
+See the option:--timer and option:--session options.
+
+[role="term"]
+----
+$ lttng disable-rotation --session=my-session --timer
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
+man:lttng(1),
 man:lttng-enable-rotation(1),
-man:lttng(1)
+man:lttng-rotate(1),
+man:lttng-concepts(7)