[lttng-dev] [PATCH lttng-tools] Documentation: document tracefile max size discarded event limitation

[David Goulet]

Merged

On 21 May (12:10:24), Mathieu Desnoyers wrote:
> Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers at efficios.com>
> CC: David Goulet <dgoulet at efficios.com>
> ---
>  doc/man/lttng.1                          |    2 ++
>  src/bin/lttng/commands/enable_channels.c |    2 ++
>  2 files changed, 4 insertions(+)
> 
> diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
> index ef73b06..42105c5 100644
> --- a/doc/man/lttng.1
> +++ b/doc/man/lttng.1
> @@ -442,6 +442,8 @@ Use shared buffer for the whole system (\-k only)
>  .BR "\-C, \-\-tracefile-size SIZE"
>  Maximum size of each tracefile within a stream (in bytes).
>  0 means unlimited. (default: 0)
> +Note: traces generated with this option may inaccurately report
> +discarded events as per CTF 1.8.
>  .TP
>  .BR "\-W, \-\-tracefile-count COUNT"
>  Used in conjunction with \-C option, this will limit the number of files
> diff --git a/src/bin/lttng/commands/enable_channels.c b/src/bin/lttng/commands/enable_channels.c
> index 55fbae6..4a1de2c 100644
> --- a/src/bin/lttng/commands/enable_channels.c
> +++ b/src/bin/lttng/commands/enable_channels.c
> @@ -136,6 +136,8 @@ static void usage(FILE *ofp)
>  	fprintf(ofp, "  -C, --tracefile-size SIZE\n");
>  	fprintf(ofp, "                           Maximum size of each tracefile within a stream (in bytes). 0 means unlimited.\n");
>  	fprintf(ofp, "                               (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_SIZE);
> +	fprintf(ofp, "                           Note: traces generated with this option may inaccurately report\n");
> +	fprintf(ofp, "                           discarded events as per CTF 1.8.\n");
>  	fprintf(ofp, "  -W, --tracefile-count COUNT\n");
>  	fprintf(ofp, "                           Used in conjunction with -C option, this will limit the number\n");
>  	fprintf(ofp, "                           of files created to the specified count. 0 means unlimited.\n");
> -- 
> 1.7.10.4
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 603 bytes
Desc: Digital signature
URL: <http://lists.lttng.org/pipermail/lttng-dev/attachments/20140521/402ae10a/attachment.sig>