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

[Jérémie Galarneau]

Change subject to "Add man page for..."

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

"state dump" in two words

> +
> +[verse]
> +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION']
> +
>  DESCRIPTION
>  -----------
>  The `lttng regenerate` command manages a tracing session's data regeneration
>  options.
>
> -As of this version, only the `metadata` command's action is available.
> +As of this version, the `metadata` and `statedump` command's action are

command actions

> +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.
>
>  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.
>
>
> --
> 1.9.1
>



-- 
Jérémie Galarneau
EfficiOS Inc.
http://www.efficios.com