clock: show that enumerations need to have their type declared

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

diff --git a/common-trace-format-specification.txt b/common-trace-format-specification.txt
index 83d0fc144c46bf47083297f92354ae7905264428..90a669b849a4fb45f7b47e66723f64e1c3217f12 100644 (file)
--- a/common-trace-format-specification.txt
+++ b/common-trace-format-specification.txt
@@ -1250,13 +1250,15 @@ struct {
 Clock metadata allows to describe the clock topology of the system, as
 well as to detail each clock parameter. In absence of clock description,
 it is assumed that all fields named "timestamp" use the same clock
-source, which increment once per nanosecond.
+source, which increments once per nanosecond.
 
 Describing a clock and how it is used by streams is threefold: first,
 the clock and clock topology should be described in a "clock"
 description block, e.g.:
 
-enum clocks {
+typealias integer { size = 32; align = 32; signed = true } := uint32_t;
+
+enum clocks : uint32_t {
        cycle_counter,
 };