Blame doc/ABI/README

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