update endian -> byte_order

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

diff --git a/common-trace-format-proposal.txt b/common-trace-format-proposal.txt
index 71d9140704eb049dba1032c11c392f209f802b21..f8ddcacc2811867dbcc2fdd9b99ed4d80bed9dca 100644 (file)
--- a/common-trace-format-proposal.txt
+++ b/common-trace-format-proposal.txt
@@ -598,7 +598,7 @@ trace {
 };
 
 If a packet header lacks the "magic" number field, the trace endianness
-needs to be specified in the trace "endian" metadata attribute.
+needs to be specified in the trace "byte_order" metadata attribute.
 
 If the trace_uuid is not present, no validation that the metadata
 actually corresponds to the stream is performed.
@@ -876,6 +876,7 @@ The target dynamic scope must be specified explicitly when referring to
 a field outside of the local static scope. The dynamic scope prefixes
 are thus:
 
+ - Trace Packet Header: <trace.packet.header. >,
  - Stream Packet Context: <stream.packet.context. >,
  - Event Header: <stream.event.header. >,
  - Stream Event Context: <stream.event.context. >,
@@ -902,7 +903,7 @@ TSDL Grammar. This section presents a rather ligher reading that
 consists in examples of TSDL metadata, with template values.
 
 Note that the trace endianness is usually extracted from the packet
-header magic number. The "endian" field is only needed when the magic
+header magic number. The "byte_order" field is only needed when the magic
 number packet header field is not present.
 
 The stream "id" can be left out if there is only one stream in the
@@ -913,7 +914,7 @@ trace {
   major = value;                               /* Trace format version */
   minor = value;
   uuid = "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa";       /* Trace UUID */
-  endian = big OR little;                      /* Endianness (optional) */
+  byte_order = be OR le;                       /* Endianness (optional) */
   packet.header := struct {
     uint32_t magic;
     uint8_t  trace_uuid[16];