Blame doc/ABI/README

Packit Service 311553
libyang ABI/API changes
Packit Service 311553
=======================
Packit Service 311553
Packit Service 311553
Here is a script to build information about changes in libyang ABI/API
Packit Service 311553
between its versions. Such an overview can help developers migrating from
Packit Service 311553
one version to another. The script uses Andrey Ponomarenko's tools from ABI
Packit Service 311553
Laboratory [1], so it is necessary to install these tools first. To do so,
Packit Service 311553
you can use the automatic installer from [2]. Target must be 'abi-tracker'.
Packit Service 311553
Packit Service 311553
Note: Some others tools are used by the LVC toolset and not all of them are
Packit Service 311553
      correctly checked, so be careful and check warnings and error
Packit Service 311553
      messages (e.g. I have been missing correct version of ctags).
Packit Service 311553
Packit Service 311553
Then here is the 'abi.sh' to build ABI/API timeline for libyang. By default
Packit Service 311553
it includes all the versions from the project start to the current devel
Packit Service 311553
branch.
Packit Service 311553
Packit Service 311553
You can limit the number of included libyang versions via a number given
Packit Service 311553
as a parameter to the script. For example
Packit Service 311553
Packit Service 311553
$ ./abi.sh 10
Packit Service 311553
Packit Service 311553
builds overview for the last 10 libyang versions.
Packit Service 311553
Packit Service 311553
Or you can compare only two specific libyang versions providing the version
Packit Service 311553
numbers as script parameters:
Packit Service 311553
Packit Service 311553
$ ./abi.sh 0.4.0 0.5.20
Packit Service 311553
Packit Service 311553
The result is in all cases stored as 'timeline/libyang/index.html' file.
Packit Service 311553
Packit Service 311553
[1] - https://github.com/lvc
Packit Service 311553
[2] - https://github.com/lvc/installer/releases
Packit Service 311553