| Radek Krejci | 4a2c755 | 2016-02-22 15:09:35 +0100 | [diff] [blame] | 1 | libnetconf2 ABI/API changes |
| 2 | =========================== |
| 3 | |
| 4 | Here is a script to build information about changes in libnetconf2 ABI/API |
| 5 | between its versions. Such an overview can help developers migrating from |
| 6 | one version to another. The script uses Andrey Ponomarenko's tools from ABI |
| 7 | Laboratory [1], so it is necessary to install these tools first. To do so, |
| 8 | you can use the automatic installer from [2]. Target must be 'abi-tracker'. |
| 9 | |
| 10 | Note: Some others tools are used by the LVC toolset and not all of them are |
| 11 | correctly checked, so be carefull and check warnings and error |
| 12 | messages (e.g. I have been missing correct version of ctags). |
| 13 | |
| 14 | Then here is the 'abi.sh' to build ABI/API timeline for libnetconf2. By default |
| 15 | it includes all the versions from the project start to the current devel |
| 16 | branch. |
| 17 | |
| 18 | You can limit the number of included libnetconf2 versions via a number given |
| 19 | as a parameter to the script. For example |
| 20 | |
| 21 | $ ./abi.sh 10 |
| 22 | |
| 23 | builds overview for the last 10 libnetconf2 versions. |
| 24 | |
| 25 | Or you can compare only two specific libnetconf2 versions providing the version |
| 26 | numbers as script parameters: |
| 27 | |
| 28 | $ ./abi.sh 0.1.0 0.2.3 |
| 29 | |
| 30 | The result is in all cases stored as 'timeline/libnetconf2/index.html' file. |
| 31 | |
| 32 | [1] - https://github.com/lvc |
| 33 | [2] - https://github.com/lvc/installer/releases |
| 34 | |