Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 1.89 KB

CHANGELOG.md

File metadata and controls

44 lines (37 loc) · 1.89 KB

Unreleased

No changes yet.

0.3.0

  • You can now enable and disable the building of certain APIs when calling CMake, via the following flags:
    • GTIRB_CXX_API to control the building of the C++ API, on by default
    • GTIRB_PY_API to control the building of the Python API, on by default if python3 is installed on your system
  • The following changes have been made to the Python API:
    • Serialization.decode can now take a bytes object in addition to a BytesIO object.
    • If an unknwon type is encountered while decoding AuxData, it will be placed in data as a bytes-like object instead of throwing a DecodeError. Unknown data decoded this way can be then encoded again. It is still an error to encode unknown types of auxdata not in the manner described above.
  • ImageByteMap::setData() has been extended to support arbitrary iterator types.
  • We now build documentation for the Python API using Sphinx. To generate all documentation locally, call make doc after calling cmake; this will generate both C++ and Python API documentation. To only make one or the other, call make doxy or make sphinx, respectively.
    • Making the Sphinx documentation will require the following Python packages:
      pip3 install sphinx sphinx-autodoc-typehints

0.2.0

  • Added a new Python API, meant to be a high-level wrapper over the Protobuf-generated one. To make use of it, add the python folder from your build directory to your PYTHONPATH. The package is named gtirb.
  • CMake now won't automatically download and install its dependencies, so that the user has control over which versions are in use. The version requirements for Boost and Protobuf are listed in README.md.
  • Updated the sanctioned AuxData definitions.
  • Fix for build issue when using Boost 1.71.0.

0.1.1

  • Initial public release.