[deliverable/barectf.git] / CHANGELOG.md

# barectf 2 changelog

## barectf v2.1.3

**Minor improvements**:

  * Allow no or empty event payload type, as long as the event is not
    empty itself (contains at least one field in its 4 entities)

**Tests**:

  * Remove no/empty event payload type config tests
  * Add config test for empty event

**README.md**:

  * Add image on top
  * Add Community section


## barectf v2.1.2

**Bug fixes**:

  * Inherit from appropriate unsigned integer type aliases in
    `stdint.yaml` for self-aligned, signed integer type aliases


## barectf v2.1.1

**Bug fixes**:

  * Force clock offset object properties to their default values when
    set to `null`

**README.md**:

  * Update Babeltrace's URL
  * Add `--python=python3` option to virtualenv line in the
    testing section


## barectf v2.1.0

**Features**:

  * Add `$include` property to metadata, clock, trace, stream, and
    event objects to [include external YAML files](https://github.com/efficios/barectf/wiki/Including-external-YAML-files)
  * Object properties which have a default value can force it
    with `null`; this is especially useful when also using type
    inheritance or including external YAML files

**Bug fixes**:

  * Fix a few error messages
  * Use appropriate prefix for event context type parameters in
    generated code
  * `_write_cstring()`: use prefix
  * Enumeration type object: start from current last value when
    adding label-only members to parent object
  * Check the size of the `id` (event header) and `stream_id`
    (packet header) to make sure they can fit all events/streams
  * Reduce the number of compiler warnings when using `-Wall` and
    `-pedantic`
  * Make sure all entity types are structure types
  * Make sure all enumeration type object member values fit within
    the enumeration's value type
  * Check for unknown properties in enumeration type object
  * Check for unknown properties in floating point number size object
  * Check for unknown `base` values in integer type object
  * Check the type of the `byte-order` property in trace object
  * Check the signedness of the `uuid` field's element type in the
    trace packet header type
  * Check for unknown properties in configuration object
  * Check node type before checking its properties
  * Use unions to write floating point numbers to avoid aliasing warnings

**Tests**:

  * Add configuration file tests

**README.md**:

  * Add CI badge
  * Add C99 compliance limitation
  * Move documentation to the project's wiki


## barectf v2.0.2

**README.md**:

  * Add PyPI badge
  * Fix Arch Linux installation command line


## barectf v2.0.1

**Bug fixes**:

  * Fix various bugs in the Parallella platform


## barectf v2.0.0

Initial release.

Major changes from barectf 0.x:

  * Single YAML configuration input
  * TSDL metadata is generated by barectf instead of being consumed
  * Introduction of platforms to handle buffers automatically with
    custom callbacks and to allow continuous tracing
  * Various optimizations in the generated C code
Commit	Line	Data
f6be1e13 PP	1	# barectf 2 changelog
f6be1e13 PP	2
7df67d66 PP	3	## barectf v2.1.3
	4
	5	Minor improvements:
	6
	7	* Allow no or empty event payload type, as long as the event is not
	8	empty itself (contains at least one field in its 4 entities)
	9
	10	Tests:
	11
	12	* Remove no/empty event payload type config tests
	13	* Add config test for empty event
	14
	15	README.md:
	16
	17	* Add image on top
	18	* Add Community section
	19
	20
f6bf761c PP	21	## barectf v2.1.2
	22
	23	Bug fixes:
	24
	25	* Inherit from appropriate unsigned integer type aliases in
	26	`stdint.yaml` for self-aligned, signed integer type aliases
	27
	28
f9e8f1c9 PP	29	## barectf v2.1.1
	30
	31	Bug fixes:
	32
	33	* Force clock offset object properties to their default values when
	34	set to `null`
	35
	36	README.md:
	37
	38	* Update Babeltrace's URL
	39	* Add `--python=python3` option to virtualenv line in the
	40	testing section
	41
	42
e4f5f5f4 PP	43	## barectf v2.1.0
	44
	45	Features:
	46
	47	* Add `$include` property to metadata, clock, trace, stream, and
	48	event objects to [include external YAML files](https://github.com/efficios/barectf/wiki/Including-external-YAML-files)
	49	* Object properties which have a default value can force it
	50	with `null`; this is especially useful when also using type
	51	inheritance or including external YAML files
	52
	53	Bug fixes:
	54
	55	* Fix a few error messages
	56	* Use appropriate prefix for event context type parameters in
	57	generated code
	58	* `_write_cstring()`: use prefix
	59	* Enumeration type object: start from current last value when
	60	adding label-only members to parent object
	61	* Check the size of the `id` (event header) and `stream_id`
	62	(packet header) to make sure they can fit all events/streams
	63	* Reduce the number of compiler warnings when using `-Wall` and
	64	`-pedantic`
	65	* Make sure all entity types are structure types
	66	* Make sure all enumeration type object member values fit within
	67	the enumeration's value type
	68	* Check for unknown properties in enumeration type object
	69	* Check for unknown properties in floating point number size object
	70	* Check for unknown `base` values in integer type object
	71	* Check the type of the `byte-order` property in trace object
	72	* Check the signedness of the `uuid` field's element type in the
	73	trace packet header type
	74	* Check for unknown properties in configuration object
	75	* Check node type before checking its properties
	76	* Use unions to write floating point numbers to avoid aliasing warnings
	77
	78	Tests:
	79
	80	* Add configuration file tests
	81
	82	README.md:
	83
b7c42d35	84	* Add CI badge
e4f5f5f4 PP	85	* Add C99 compliance limitation
	86	* Move documentation to the project's wiki
	87
	88
f6be1e13 PP	89	## barectf v2.0.2
	90
	91	README.md:
	92
	93	* Add PyPI badge
	94	* Fix Arch Linux installation command line
	95
	96
	97	## barectf v2.0.1
	98
	99	Bug fixes:
	100
	101	* Fix various bugs in the Parallella platform
	102
	103
	104	## barectf v2.0.0
	105
	106	Initial release.
	107
	108	Major changes from barectf 0.x:
	109
	110	* Single YAML configuration input
	111	* TSDL metadata is generated by barectf instead of being consumed
	112	* Introduction of platforms to handle buffers automatically with
	113	custom callbacks and to allow continuous tracing
	114	* Various optimizations in the generated C code