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

[Thibault, Daniel]

----------------------------------------------------------------------
Date: Wed, 21 May 2014 12:10:24 -0400
From: Mathieu Desnoyers <mathieu.desnoyers at efficios.com>
To: David Goulet <dgoulet at efficios.com>

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
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");
----------------------------------------------------------------------

   "as per CTF 1.8" leaves the impression that the misreporting is "mandated".  I suspect this is not what is meant here.  Maybe "as of" instead of "as per"?

Daniel U. Thibault
Protection des systèmes et contremesures (PSC) | Systems Protection & Countermeasures (SPC)
Cyber sécurité pour les missions essentielles (CME) | Mission Critical Cyber Security (MCCS)
R & D pour la défense Canada - Valcartier (RDDC Valcartier) | Defence R&D Canada - Valcartier (DRDC Valcartier)
2459 route de la Bravoure
Québec QC  G3J 1X5
CANADA
Vox : (418) 844-4000 x4245
Fax : (418) 844-4538
NAC : 918V QSDJ <http://www.travelgis.com/map.asp?addr=918V%20QSDJ>
Gouvernement du Canada | Government of Canada
<http://www.valcartier.drdc-rddc.gc.ca/>