Explain limitations if packet header fields are not present

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

diff --git a/common-trace-format-proposal.txt b/common-trace-format-proposal.txt
index f2f7e232b4b7b0a23513a74ac24490b8286664ce..8182ea991f7da92d49b2a35e193ec91213d62762 100644 (file)
--- a/common-trace-format-proposal.txt
+++ b/common-trace-format-proposal.txt
@@ -597,6 +597,17 @@ trace {
   packet.header := struct event_packet_header;
 };
 
   packet.header := struct event_packet_header;
 };
 

+If a packet header lacks the "magic" number field, the trace endianness
+needs to be specified in the trace "endian" metadata attribute.
+
+If the trace_uuid is not present, no validation that the metadata
+actually corresponds to the stream is performed.
+
+If the stream_id packet header field is missing, the trace can only
+contain a single stream. Its "id" field can be left out, and its events
+don't need to declare a "stream_id" field.
+
+

 5.2 Event Packet Context Description
 
 Event packet context example. These are declared within the stream declaration
 5.2 Event Packet Context Description
 
 Event packet context example. These are declared within the stream declaration