Update text-based metadata header: "/* TSDL" is sufficient

[ctf.git] / common-trace-format-specification.txt

diff --git a/common-trace-format-specification.txt b/common-trace-format-specification.txt
index 8d5cc928b264fc1a11bdb72655a394236d8d1d52..da33bf30abed49ca3b7f7bb33be3aba027253125 100644 (file)
--- a/common-trace-format-specification.txt
+++ b/common-trace-format-specification.txt
@@ -933,7 +933,16 @@ 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 (without the double-quotes) :
+
+"/* TSDL"
+
+These characters allow automated discovery of file type. They are
+interpreted as a the beginning of a comment by the TSDL metadata parser.
+The comment can be continued to contain extra commented characters
+before it is closed.
 
 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