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