From 31099add7a58b2a671f9324aa023a4dc5ae000f1 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 17 May 2018 14:29:17 -0400 Subject: [PATCH] doc/man: update rotation man pages to follow API's terminology MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit "Manual rotation" becomes "immediate rotation". "Automatic rotation schedule" becomes "rotation schedule". We still write "automatic rotation" as the result of a rotation schedule being fulfilled by its condition. Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- configure.ac | 4 +-- doc/man/lttng-disable-rotation.1.txt | 25 ++++++++-------- doc/man/lttng-enable-rotation.1.txt | 43 ++++++++++++++-------------- doc/man/lttng-rotate.1.txt | 11 ++++--- 4 files changed, 40 insertions(+), 43 deletions(-) diff --git a/configure.ac b/configure.ac index 60e76b03b..cb36d6b68 100644 --- a/configure.ac +++ b/configure.ac @@ -380,10 +380,10 @@ _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CREATE], [Create a tracing session]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DESTROY], [Tear down tracing sessions]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_CHANNEL], [Disable tracing channels]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_EVENT], [Disable event rules]) -_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_ROTATION], [Unset an automatic rotation schedule]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_ROTATION], [Unset a rotation schedule]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ENABLE_CHANNEL], [Create or enable tracing channels]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ENABLE_EVENT], [Create or enable event rules]) -_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ENABLE_ROTATION], [Set an automatic rotation schedule]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ENABLE_ROTATION], [Set a rotation schedule]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_HELP], [Display help information about a command]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_LIST], [List tracing sessions, domains, channels, and events]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_LOAD], [Load tracing session configurations]) diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt index 1a9e14ef0..d69975ff7 100644 --- a/doc/man/lttng-disable-rotation.1.txt +++ b/doc/man/lttng-disable-rotation.1.txt @@ -4,7 +4,7 @@ lttng-disable-rotation(1) NAME ---- -lttng-disable-rotation - Unset a tracing session's automatic rotation schedule +lttng-disable-rotation - Unset a tracing session's rotation schedule SYNOPSIS @@ -16,33 +16,32 @@ SYNOPSIS 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 for the +current tracing session, or for the tracing session named 'SESSION' if +provided, previously set with the man:lttng-enable-rotation(1) command. include::common-cmd-options-head.txt[] -Automatic rotation schedule condition -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Rotation schedule condition +~~~~~~~~~~~~~~~~~~~~~~~~~~~ One of: 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 ~~~~~~ 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 in the tracing session named 'SESSION' + instead of the current tracing session. include::common-cmd-help-options.txt[] diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt index ad753d0c9..53189da92 100644 --- 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 <> 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[] diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt index f290cae31..5c1247396 100644 --- a/doc/man/lttng-rotate.1.txt +++ b/doc/man/lttng-rotate.1.txt @@ -33,7 +33,7 @@ The _current trace chunk_ of a given tracing session includes: event amongst: ** The first time the tracing session was started with man:lttng-start(1). -** The last rotation, either a manual one with `lttng rotate`, or an +** The last rotation, either an immediate one with `lttng rotate`, or an automatic one from a rotation schedule previously set with man:lttng-enable-rotation(1). * The content of all the non-flushed sub-buffers of the tracing @@ -135,17 +135,16 @@ The `lttng rotate` command only works when: limit (see the nloption:--tracefile-size and nloption:--tracefile-count options in man:lttng-enable-channel(1)). -* No manual rotation (`lttng rotate`) is currently happening. +* No immediate rotation (`lttng rotate`) is currently happening. -* No automatic rotation schedule is currently set (see +* No rotation schedule is currently set (see man:lttng-enable-rotation(1)). + One way around this is to: + -- -. Unset any automatic rotation schedule with - man:lttng-disable-rotation(1). -. Perform the manual rotation with `lttng rotation`. +. Unset any rotation schedule with man:lttng-disable-rotation(1). +. Perform the immediate rotation with `lttng rotation`. . **If needed**, set the rotation schedule again with man:lttng-enable-rotation(1). -- -- 2.34.1