Doc: document tracefile max size discarded event limitation

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: David Goulet <dgoulet@efficios.com>

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 627ab9c9530c7a82bfd36382fc26f850e50734d2..483df2aefab2cd8799d6db18e3b7d7c6dc4bf535 100644 (file)
--- 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 55fbae644abc0b6dc4813988a7913e7fa169759e..4a1de2c6636ecec72852f840cf23e704063b785c 100644 (file)
--- 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");