@@ -11,15 +11,15 @@ These formats are very bare bones and do not contain any additional information,
1111For more advanced use-cases, consider using the multi channel trace file format.
1212
1313*.osi::
14- Binary trace file.
14+ Single channel binary trace file.
1515Messages are separated by a length specification before each message.
1616The length is represented by a four-byte, little-endian, unsigned integer.
1717The length does not include the integer itself.
1818
1919*.txth::
20- Human -readable plain-text trace file.
20+ Single channel human -readable plain-text trace file.
2121Messages are separated by newlines.
22- Each message is a serialized OSI message in JSON format.
22+ Each message is a serialized OSI message in protocol buffer text format.
2323
2424NOTE: The `.txth` format is intended for human consumption (e.g. for debugging and manual checks).
2525It is currently not supported for reading by the OSI API, as it is not unambiguously deserializable.
@@ -103,7 +103,7 @@ A human-readable description of the data contained in the multi channel trace fi
103103A list separated by commas of entities (not tools) involved in the creation of the data contained in the file.
104104
105105`license`::
106- If the file is licensed under any SPDX registered license, this entry should contain the SPDX identifier for the license.
106+ If the contents of the file is licensed under any SPDX registered license, this entry should contain the SPDX identifier for the license.
107107
108108`data_sources`::
109109A list separated by commas of data sources used in the creation of the data contained in the file.
@@ -136,7 +136,9 @@ The schema record must be stored in the summary section of the trace file, and m
136136[#sec-osi-trace-file-multi-channel]
137137=== OSI channel
138138
139- An OSI channel is a data stream within the OSI multi channel trace file that contains serialized OSI messages of the same type.
139+ An OSI channel is a data stream within the OSI multi channel trace file that contains serialized OSI top-level messages of the same type.
140+ Note that non-top-level messages must not be stored directly in OSI channels.
141+
140142Each OSI channel must be described by a channel record in the summary section of the trace file with the following fields:
141143
142144`id`::
0 commit comments