doc/man: update rotation man pages to follow API's terminology

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

diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt
index ad753d0c9d7c5a7ff626a747d8d4a0cd8f999489..53189da925137ef2cb2c431a794b06d33036a531 100644 (file)
--- a/doc/man/lttng-enable-rotation.1.txt
+++ b/doc/man/lttng-enable-rotation.1.txt
@@ -4,7 +4,7 @@ lttng-enable-rotation(1)
 
 NAME
 ----
-lttng-enable-rotation - Set a tracing session's automatic rotation schedule
+lttng-enable-rotation - Set a tracing session's rotation schedule
 
 
 SYNOPSIS
@@ -16,10 +16,10 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-The `lttng enable-rotation` command sets an automatic rotation schedule
-for the current tracing session, or for the tracing session named
-'SESSION' if provided. See man:lttng-rotate(1) for more information
-about the concepts of a tracing session _rotation_ and a _trace chunk_.
+The `lttng enable-rotation` command sets a rotation schedule for the
+current tracing session, or for the tracing session named 'SESSION' if
+provided. See man:lttng-rotate(1) for more information about the
+concepts of a tracing session _rotation_ and a _trace chunk_.
 
 With the option:--timer option, the rotation schedule is set so that an
 automatic rotation occurs at least every 'PERIOD' (microseconds without
@@ -41,14 +41,14 @@ nloption:--monitor-timer option in man:lttng-enable-channel(1) for more
 information about the monitor timer.
 
 The naming convention of a trace chunk archive which an automatic
-rotation creates is the same as with the manual rotation command,
+rotation creates is the same as with the immediate rotation command,
 man:lttng-rotate(1).
 
-For a given tracing session, you cannot set multiple automatic rotation
-schedules with the option:--timer or the option:--size option.
+For a given tracing session, you cannot set multiple rotation schedules
+with the option:--timer or the option:--size option.
 
-You can unset an automatic rotation schedule with the
-man:lttng-disable-rotation(1) command.
+You can unset a rotation schedule with the man:lttng-disable-rotation(1)
+command.
 
 See <<limitations,LIMITATIONS>> for important limitations regarding
 this command.
@@ -57,28 +57,27 @@ this command.
 include::common-cmd-options-head.txt[]
 
 
-Automatic rotation schedule condition
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Rotation schedule condition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 One of:
 
 option:--size='SIZE'::
-    Set an automatic rotation schedule so that an automatic rotation
-    occurs every time the total size of the flushed part of the current
-    trace chunk is at least 'SIZE' bytes. The `k` (kiB), `M` (MiB), and
-    `G` (GiB) suffixes are supported.
+    Set a rotation schedule so that an automatic rotation occurs every
+    time the total size of the flushed part of the current trace chunk
+    is at least 'SIZE' bytes. The `k` (kiB), `M` (MiB), and `G` (GiB)
+    suffixes are supported.
 
 option:--timer='PERIOD'::
-    Set an automatic rotation schedule so that an automatic rotation
-    occurs at least every 'PERIOD' microseconds. The
-    `ms` (milliseconds), `s` (seconds), `m` (minutes), and `h` (hours)
-    suffixes are supported.
+    Set a rotation schedule so that an automatic rotation occurs at
+    least every 'PERIOD' microseconds. The `ms` (milliseconds), `s`
+    (seconds), `m` (minutes), and `h` (hours) suffixes are supported.
 
 
 Target
 ~~~~~~
 option:-s 'SESSION', option:--session='SESSION'::
-    Set an automatic rotation schedule for the tracing session named
-    'SESSION' instead of the current tracing session.
+    Set a rotation schedule for the tracing session named 'SESSION'
+    instead of the current tracing session.
 
 
 include::common-cmd-help-options.txt[]