Add dynamic array tracing tests
[deliverable/barectf.git] / CHANGELOG.md
1 # barectf 2 changelog
2
3 ## barectf v2.3.1
4
5 **Fixes**:
6
7 * Share operations between event size computation and event
8 serialization to avoid buffer overflow.
9 * Do not sample clock when closing and opening packets when this is
10 done because the current event does not fit the current packet. This
11 avoids a packet's first event having a timestamp that is less than
12 the packet's beginning timestamp.
13
14 ## barectf v2.3.0
15
16 **Features**:
17
18 * Add tracing activity and tracing section API to check whether or not
19 the traced thread is currently within a barectf tracing function and
20 to enable or disable tracing.
21
22 **Tests**:
23
24 * Add tox configuration.
25
26 **Fixes**:
27
28 * Fix various testing infrastructure issues.
29 * Fix generated `bitfield.h` big-endian macros.
30
31
32 ## barectf v2.2.1
33
34 **Minor improvements**:
35
36 * barectf now generates ANSI C code.
37 * The generated code can be compiled with a C++ compiler.
38
39 **README.md**:
40
41 * barectf claims to generate ANSI C code.
42 * Reword some paragraphs.
43
44
45 ## barectf v2.2.0
46
47 **Features**:
48
49 * Add `$default` boolean property to stream objects, and
50 `$default-stream` string property to the metadata object, to specify
51 a _default stream_: when a default stream exists, tracing function
52 aliases without the default stream name (`barectf_trace_my_event()`,
53 for example) are also generated
54 * Add `options` property to the configuration object, with:
55 * `gen-prefix-def`: true to generate a preprocessor definition
56 (`#define`) in `barectf.h` for the effective prefix
57 * `gen-default-stream-def`: true to generate a preprocessor
58 definition for the default stream name, if any
59 * Create `barectf-tracepoint.h`, a bridging C header file that
60 allows LTTng-UST tracepoints to be used as is with barectf by
61 providing the same `tracepoint()` macro
62
63 **Tests**:
64
65 * Test the new `$default` (stream object), `$default-stream` (metadata
66 object), and `options` (configuration object) properties
67
68 **README.md**:
69
70 * Add instructions for installing barectf on Arch Linux using the AUR
71 * Add instructions for installing barectf on Ubuntu using a PPA
72
73
74 ## barectf v2.1.4
75
76 **Minor improvements**:
77
78 * Override default metadata `env` entries with user entries instead of
79 the opposite
80 * Statically align and compute the size of event fields when possible
81 for the `_get_event_size_*()` functions when possible
82
83 **Bug fixes**:
84
85 * Do not write event's `stream_id` or stream's `id` when the trace
86 packet header type has no `stream_id` field.
87
88 **Tests**:
89
90 * Add config test for multiple streams, no `stream_id` field in packet
91 header type
92
93 **README.md**:
94
95 * Indicate how to install the command's man page
96
97
98 ## barectf v2.1.3
99
100 **Minor improvements**:
101
102 * Allow no or empty event payload type, as long as the event is not
103 empty itself (contains at least one field in its 4 entities)
104
105 **Tests**:
106
107 * Remove no/empty event payload type config tests
108 * Add config test for empty event
109
110 **README.md**:
111
112 * Add image on top
113 * Add Community section
114
115
116 ## barectf v2.1.2
117
118 **Bug fixes**:
119
120 * Inherit from appropriate unsigned integer type aliases in
121 `stdint.yaml` for self-aligned, signed integer type aliases
122
123
124 ## barectf v2.1.1
125
126 **Bug fixes**:
127
128 * Force clock offset object properties to their default values when
129 set to `null`
130
131 **README.md**:
132
133 * Update Babeltrace's URL
134 * Add `--python=python3` option to virtualenv line in the
135 testing section
136
137
138 ## barectf v2.1.0
139
140 **Features**:
141
142 * Add `$include` property to metadata, clock, trace, stream, and
143 event objects to [include external YAML files](https://github.com/efficios/barectf/wiki/Including-external-YAML-files)
144 * Object properties which have a default value can force it
145 with `null`; this is especially useful when also using type
146 inheritance or including external YAML files
147
148 **Bug fixes**:
149
150 * Fix a few error messages
151 * Use appropriate prefix for event context type parameters in
152 generated code
153 * `_write_cstring()`: use prefix
154 * Enumeration type object: start from current last value when
155 adding label-only members to parent object
156 * Check the size of the `id` (event header) and `stream_id`
157 (packet header) to make sure they can fit all events/streams
158 * Reduce the number of compiler warnings when using `-Wall` and
159 `-pedantic`
160 * Make sure all entity types are structure types
161 * Make sure all enumeration type object member values fit within
162 the enumeration's value type
163 * Check for unknown properties in enumeration type object
164 * Check for unknown properties in floating point number size object
165 * Check for unknown `base` values in integer type object
166 * Check the type of the `byte-order` property in trace object
167 * Check the signedness of the `uuid` field's element type in the
168 trace packet header type
169 * Check for unknown properties in configuration object
170 * Check node type before checking its properties
171 * Use unions to write floating point numbers to avoid aliasing warnings
172
173 **Tests**:
174
175 * Add configuration file tests
176
177 **README.md**:
178
179 * Add CI badge
180 * Add C99 compliance limitation
181 * Move documentation to the project's wiki
182
183
184 ## barectf v2.0.2
185
186 **README.md**:
187
188 * Add PyPI badge
189 * Fix Arch Linux installation command line
190
191
192 ## barectf v2.0.1
193
194 **Bug fixes**:
195
196 * Fix various bugs in the Parallella platform
197
198
199 ## barectf v2.0.0
200
201 Initial release.
202
203 Major changes from barectf 0.x:
204
205 * Single YAML configuration input
206 * TSDL metadata is generated by barectf instead of being consumed
207 * Introduction of platforms to handle buffers automatically with
208 custom callbacks and to allow continuous tracing
209 * Various optimizations in the generated C code
This page took 0.036997 seconds and 4 git commands to generate.