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