[lttng-dev] [PATCH lttng-tools v2 6/6] Manpage for the regenerate statedump command

[Philippe Proulx]

On Mon, Jul 4, 2016 at 11:13 AM, Julien Desfossez
<jdesfossez at efficios.com> wrote:
>
> Signed-off-by: Julien Desfossez <jdesfossez at efficios.com>
> Reviewed-by: Mathieu Desnoyers <mathieu.desnoyers at efficios.com>
> ---
>  doc/man/lttng-regenerate.1.txt | 15 +++++++++++++--
>  1 file changed, 13 insertions(+), 2 deletions(-)
>
> diff --git a/doc/man/lttng-regenerate.1.txt b/doc/man/lttng-regenerate.1.txt
> index dbbfa4d..80bae20 100644
> --- a/doc/man/lttng-regenerate.1.txt
> +++ b/doc/man/lttng-regenerate.1.txt
> @@ -14,12 +14,19 @@ Regenerate the metadata of a session

Missing trailing colon.

>  [verse]
>  *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate metadata* [option:--session='SESSION']
>
> +Regenerate the statedump of a session

Missing trailing colon.

> +
> +[verse]
> +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION']
> +
>  DESCRIPTION
>  -----------
>  The `lttng regenerate` command manages a tracing session's data regeneration
>  options.

The `lttng regenerate` command regenerates specific data of a tracing session.

>
> -As of this version, only the `metadata` command's action is available.
> +As of this version, the `metadata` and `statedump` command's action are
> +available.
> +
>  Regenerating a tracing session's metadata can be used to
>  resample the offset between the system's monotonic clock and
>  the wall-clock time.
> @@ -32,12 +39,16 @@ traced before its wall time is NTP-corrected. Regenerating the tracing
>  session's metadata ensures that trace viewers can accurately determine
>  the events time relative to Unix Epoch.
>
> +Regenerating a tracing session's statedump can be used to collect up-to-date
> +statedump informations during the trace session. This is particularly useful in
> +snapshot or trace-file rotation modes where the statedump information may be
> +lost.

Let's replace those three last paragraphs with this:

As of this version, the `metadata` and `statedump` actions are
available.


Regenerating a tracing session's metadata
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The `lttng regenerate metadata` action can be used to resample the
offset between the system's monotonic clock and the wall-clock time.

This action is meant to be used to resample the wall-clock time
following a major
link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP]
correction. As such, a system booting with an incorrect wall time can be
traced before its wall time is NTP-corrected. Regenerating the tracing
session's metadata ensures that trace viewers can accurately determine
the events time relative to Unix Epoch.


Regenerating a tracing session's state dump
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The `lttng regenerate statedump` action can be used to collect
up-to-date state dump information during the tracing session. This is
particularly useful in snapshot (see man:lttng-snapshot(1)) or trace
file rotation (see man:lttng-enable-channel(1)) modes where the state
dump information may be lost.

>
>  include::common-cmd-options-head.txt[]
>
>
>  option:-s, option:--session='SESSION'::
> -    Manage the metadata generation of the tracing session named 'SESSION'
> +    Manage the data regeneration of the tracing session named 'SESSION'
>      instead of the current tracing session.

Regenerate the data of the tracing session named [...]

>
>
> --
> 1.9.1
>
> _______________________________________________
> lttng-dev mailing list
> lttng-dev at lists.lttng.org
> https://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev