doc/man: remove AUTHORS section

[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 ef2b21611182f9c81ac2b6f7f0ecfd9d9fb2df2b..37c9e2c7be4fa021d12aaf9aa47dd76aced9f603 100644 (file)
--- a/doc/man/lttng-enable-rotation.1.txt
+++ b/doc/man/lttng-enable-rotation.1.txt
@@ -10,8 +10,8 @@ lttng-enable-rotation - Set a tracing session's rotation schedule
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* (option:--timer='PERIOD' | option:--size='SIZE')
-      [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* [option:--session='SESSION']
+      (option:--timer='PERIOD' | option:--size='SIZE' | option:--timer='PERIOD' option:--size='SIZE')

 
 
 DESCRIPTION
 
 
 DESCRIPTION


@@ -30,16 +30,19 @@ 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
 without a unit suffix).
 
 flushed part of the current trace chunk is at least 'SIZE' (bytes
 without a unit suffix).
 

-With both the option:--timer and option:--size options, LTTng checks the
+For both option:--timer and option:--size options, LTTng checks the

 schedule condition periodically using the monitor timers of the tracing
 session's channels. This means that, with the option:--timer option, the
 automatic rotation can occur when the elapsed time since the last
 automatic rotation is greater than 'PERIOD', and with the option:--size
 option, the automatic rotation can occur when the size of the flushed
 schedule condition periodically using the monitor timers of the tracing
 session's channels. This means that, with the option:--timer option, the
 automatic rotation can occur when the elapsed time since the last
 automatic rotation is greater than 'PERIOD', and with the option:--size
 option, the automatic rotation can occur when the size of the flushed

-part of the current trace chunk is greater than 'SIZE'. See the
+part of the current trace chunk is greater than 'SIZE'. Therefore the
+'PERIOD' and 'SIZE' arguments are approximations. See the

 nloption:--monitor-timer option in man:lttng-enable-channel(1) for more
 information about the monitor timer.
 
 nloption:--monitor-timer option in man:lttng-enable-channel(1) for more
 information about the monitor timer.
 

+You can combine the option:--timer and option:--size options.
+

 The naming convention of a trace chunk archive which an automatic
 rotation creates is the same as with the immediate rotation command,
 man:lttng-rotate(1).
 The naming convention of a trace chunk archive which an automatic
 rotation creates is the same as with the immediate rotation command,
 man:lttng-rotate(1).


@@ -56,8 +59,6 @@ include::common-cmd-options-head.txt[]
 
 Rotation schedule condition
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Rotation schedule condition
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

-One of:
-

 option:--size='SIZE'::
     Set a rotation schedule so that an automatic rotation occurs every
     time the total size of the flushed part of the current trace chunk
 option:--size='SIZE'::
     Set a rotation schedule so that an automatic rotation occurs every
     time the total size of the flushed part of the current trace chunk