Describe text-only metadata header: /* TSDL */
authorMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Sun, 31 Jul 2011 17:41:51 +0000 (13:41 -0400)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Sun, 31 Jul 2011 17:41:51 +0000 (13:41 -0400)
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
common-trace-format-specification.txt

index 8d5cc928b264fc1a11bdb72655a394236d8d1d52..19194c840c706db912caf72185403f2c5345b7cd 100644 (file)
@@ -933,7 +933,14 @@ CTF stream packet facilities (checksumming, compression, encryption,
 network-readiness) for meta-data stream generated and transported by a
 tracer.
 
-The text-only meta-data file is a plain text TSDL description.
+The text-only meta-data file is a plain-text TSDL description. This file
+must begin with the following characters to identify the file as a CTF
+TSDL text-based metadata file:
+
+/* TSDL */
+
+These characters allow automated discovery of file type. They are
+interpreted as a comment by the TSDL metadata parser.
 
 The packet-based meta-data is made of "meta-data packets", which each
 start with a meta-data packet header. The packet-based meta-data
This page took 0.033803 seconds and 4 git commands to generate.