Specify that trace readers (and not parser) should remove leading field underscores

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

diff --git a/common-trace-format-specification.txt b/common-trace-format-specification.txt
index cb28d6afee7aecb7a730aed9a605bf6c75a54b68..d306ffc06a5cab5734e3e42622c71dc37e5147df 100644 (file)
--- a/common-trace-format-specification.txt
+++ b/common-trace-format-specification.txt
@@ -421,7 +421,8 @@ possess a field name, which is a unique identifier within the structure.
 The identifier is not allowed to use any reserved keyword
 (see Section C.1.2). Replacing reserved keywords with
 underscore-prefixed field names is recommended. Fields starting with an
 The identifier is not allowed to use any reserved keyword
 (see Section C.1.2). Replacing reserved keywords with
 underscore-prefixed field names is recommended. Fields starting with an

-underscore should have their leading underscore removed by the CTF parser.
+underscore should have their leading underscore removed by the CTF trace
+readers.

 
 A nameless structure can be declared as a field type or as part of a typedef:
 
 
 A nameless structure can be declared as a field type or as part of a typedef:
 


@@ -463,7 +464,8 @@ Each variant type selector possess a field name, which is a unique
 identifier within the variant. The identifier is not allowed to use any
 reserved keyword (see Section C.1.2). Replacing reserved keywords with
 underscore-prefixed field names is recommended. Fields starting with an
 identifier within the variant. The identifier is not allowed to use any
 reserved keyword (see Section C.1.2). Replacing reserved keywords with
 underscore-prefixed field names is recommended. Fields starting with an

-underscore should have their leading underscore removed by the CTF parser.
+underscore should have their leading underscore removed by the CTF trace
+readers.

 
 
 A named variant declaration followed by its definition within a structure
 
 
 A named variant declaration followed by its definition within a structure


@@ -1089,7 +1091,7 @@ not permitted as field names. It is recommended that field names
 clashing with CTF and C99 reserved keywords use an underscore prefix to
 eliminate the risk of generating a description containing an invalid
 field name. Consequently, fields starting with an underscore should have
 clashing with CTF and C99 reserved keywords use an underscore prefix to
 eliminate the risk of generating a description containing an invalid
 field name. Consequently, fields starting with an underscore should have

-their leading underscore removed by the CTF parser.
+their leading underscore removed by the CTF trace readers.

 
 
 The information available in the dynamic scopes can be thought of as the
 
 
 The information available in the dynamic scopes can be thought of as the