xref: /freebsd/contrib/libcbor/CHANGELOG.md (revision 10041e99a0c29c9f99c4148fc173bb12dd26aa8d)
1Next
2---------------------
3
40.8.0 (2020-09-20)
5---------------------
6- BUILD BREAKING: Use BUILD_SHARED_LIBS to determine how to build libraries (fixed Windows linkage) [[#148]](https://github.com/PJK/libcbor/pull/148) (by [intelligide@](https://github.com/intelligide))
7- BREAKING: Fix `cbor_tag_item` not increasing the reference count on the tagged item reference it returns [[Fixes #109](https://github.com/PJK/libcbor/issues/109)] (discovered bt [JohnGilmour](https://github.com/JohnGilmour))
8  - If you have previously relied on the broken behavior, you can use `cbor_move` to emulate as long as the returned handle is an "rvalue"
9- BREAKING: [`CBOR_DECODER_EBUFFER` removed from `cbor_decoder_status`](https://github.com/PJK/libcbor/pull/156)
10    - `cbor_stream_decode` will set `CBOR_DECODER_NEDATA` instead if the input buffer is empty
11- [Fix `cbor_stream_decode`](https://github.com/PJK/libcbor/pull/156) to set `cbor_decoder_result.required` to the minimum number of input bytes necessary to receive the next callback (as long as at least one byte was passed) (discovered by [woefulwabbit](https://github.com/woefulwabbit))
12- Fixed several minor manpage issues [[#159]](https://github.com/PJK/libcbor/pull/159) (discovered by [kloczek@](https://github.com/kloczek))
13
140.7.0 (2020-04-25)
15---------------------
16- Fix bad encoding of NaN half-floats [[Fixes #53]](https://github.com/PJK/libcbor/issues/53) (discovered by [BSipos-RKF](https://github.com/BSipos-RKF))
17    - **Warning**: Previous versions encoded NaNs as `0xf9e700` instead of `0xf97e00`; if you rely on the broken behavior, this will be a breaking change
18- Fix potentially bad encoding of negative half-float with exponent < -14 [[Fixes #112]](https://github.com/PJK/libcbor/issues/112) (discovered by [yami36](https://github.com/yami36))
19- BREAKING: Improved bool support [[Fixes #63]](https://github.com/PJK/libcbor/issues/63)
20    - Rename `cbor_ctrl_is_bool` to `cbor_get_bool` and fix the behavior
21    - Add `cbor_set_bool`
22- Fix memory_allocation_test breaking the build without CBOR_CUSTOM_ALLOC [[Fixes #128]](https://github.com/PJK/libcbor/issues/128) (by [panlinux](https://github.com/panlinux))
23- [Fix a potential build issue where cJSON includes may be misconfigured](https://github.com/PJK/libcbor/pull/132)
24- Breaking: [Add a limit on the size of the decoding context stack](https://github.com/PJK/libcbor/pull/138) (by [James-ZHANG](https://github.com/James-ZHANG))
25    - If your usecase requires parsing very deeply nested structures, you might need to increase the default 2k limit via `CBOR_MAX_STACK_SIZE`
26- Enable LTO/IPO based on [CheckIPOSupported](https://cmake.org/cmake/help/latest/module/CheckIPOSupported.html#module:CheckIPOSupported) [[#143]](https://github.com/PJK/libcbor/pull/143) (by [xanderlent](https://github.com/xanderlent))
27    - If you rely on LTO being enabled and use CMake version older than 3.9, you will need to re-enable it manually or upgrade your CMake
28
290.6.1 (2020-03-26)
30---------------------
31- [Fix bad shared library version number](https://github.com/PJK/libcbor/pull/131)
32    - **Warning**: Shared library built from the 0.6.0 release is erroneously marked as version "0.6.0", which makes it incompatible with future releases *including the v0.6.X line* even though they may be compatible API/ABI-wise. Refer to the documentation for the new SO versioning scheme.
33
340.6.0 (2020-03-15)
35---------------------
36- Correctly set .so version [[Fixes #52]](https://github.com/PJK/libcbor/issues/52).
37    - **Warning**: All previous releases will be identified as 0.0 by the linker.
38- Fix & prevent heap overflow error in example code [[#74]](https://github.com/PJK/libcbor/pull/74) [[#76]](https://github.com/PJK/libcbor/pull/76) (by @nevun)
39- Correctly set OSX dynamic library version [[Fixes #75]](https://github.com/PJK/libcbor/issues/75)
40- [Fix misplaced 0xFF bytes in maps possibly causing memory corruption](https://github.com/PJK/libcbor/pull/82)
41- BREAKING: Fix handling & cleanup of failed memory allocation in constructor
42  and builder helper functions [[Fixes #84]](https://github.com/PJK/libcbor/issues/84)
43  - All cbor_new_* and cbor_build_* functions will now explicitly return NULL when memory allocation fails
44  - It is up to the client to handle such cases
45- Globally enforced code style [[Fixes #83]](https://github.com/PJK/libcbor/issues/83)
46- Fix issue possible memory corruption bug on repeated
47  cbor_(byte)string_add_chunk calls with intermittently failing realloc calls
48- Fix possibly misaligned reads and writes when endian.h is uses or when
49  running on a big-endian machine [[Fixes #99](https://github.com/PJK/libcbor/issues/99), [#100](https://github.com/PJK/libcbor/issues/100)]
50- [Improved CI setup with Travis-native arm64 support](https://github.com/PJK/libcbor/pull/116)
51- [Docs migrated to Sphinx 2.4 and Python3](https://github.com/PJK/libcbor/pull/117)
52
530.5.0 (2017-02-06)
54---------------------
55- Remove cmocka from the subtree (always rely on system or user-provided version)
56- Windows CI
57- Only build tests if explicitly enabled (`-DWITH_TESTS=ON`)
58- Fixed static header declarations (by cedric-d)
59- Improved documentation (by Michael Richardson)
60- Improved `examples/readfile.c`
61- Reworked (re)allocation to handle huge inputs and overflows in size_t [[Fixes #16]](https://github.com/PJK/libcbor/issues/16)
62- Improvements to C++ linkage (corrected `cbor_empty_callbacks`, fixed `restrict` pointers) (by Dennis Bijwaard)
63- Fixed Linux installation directory depending on architecture [[Fixes #34]](https://github.com/PJK/libcbor/issues/34) (by jvymazal)
64- Improved 32-bit support [[Fixes #35]](https://github.com/PJK/libcbor/issues/35)
65- Fixed MSVC compatibility [[Fixes #31]](https://github.com/PJK/libcbor/issues/31)
66- Fixed and improved half-float encoding [[Fixes #5](https://github.com/PJK/libcbor/issues/5), [#11](https://github.com/PJK/libcbor/issues/11)]
67
680.4.0 (2015-12-25)
69---------------------
70Breaks build & header compatibility due to:
71
72- Improved build configuration and feature check macros
73- Endianess configuration fixes (by Erwin Kroon and David Grigsby)
74- pkg-config compatibility (by Vincent Bernat)
75- enable use of versioned SONAME (by Vincent Bernat)
76- better fuzzer (wasn't random until now, ooops)
77
780.3.1 (2015-05-21)
79---------------------
80- documentation and comments improvements, mostly for the API reference
81
820.3.0 (2015-05-21)
83---------------------
84
85- Fixes, polishing, niceties across the code base
86- Updated examples
87- `cbor_copy`
88- `cbor_build_negint8`, 16, 32, 64, matching asserts
89- `cbor_build_stringn`
90- `cbor_build_tag`
91- `cbor_build_float2`, ...
92
930.2.1 (2015-05-17)
94---------------------
95- C99 support
96
970.2.0 (2015-05-17)
98---------------------
99
100- `cbor_ctrl_bool` -> `cbor_ctrl_is_bool`
101- Added `cbor_array_allocated` & map equivalent
102- Overhauled endianess conversion - ARM now works as expected
103- 'sort.c' example added
104- Significantly improved and doxyfied documentation
105
1060.1.0 (2015-05-06)
107---------------------
108
109The initial release, yay!
110