1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
NAME:
ABI Tracker - visualize ABI changes timeline of a C/C++ software library.
The tool requires input profile of the library in JSON format. It can be created manually or automatically generated by the ABI Monitor: https://github.com/lvc/abi-monitor
Sample report: https://abi-laboratory.pro/tracker/timeline/glib/
The tool is developed by Andrey Ponomarenko. Please consider to add ABI Viewer reports for visualization of the ABI structure and high detailed binary compatibility analysis: https://abi-laboratory.pro/
INSTALL:
sudo make install prefix=/usr
REQUIRES:
Perl 5 (5.8 or newer)
Elfutils
ABI Dumper (1.1 or newer)
Vtable-Dumper (1.1 or newer)
ABI Compliance Checker (2.2 or newer)
ABI Monitor (1.12 or newer)
PkgDiff (1.6.4 or newer)
RfcDiff (1.41 or newer)
You can use the installer (https://github.com/lvc/installer) to automatically download and install most of the required tools.
USAGE:
abi-tracker [options] [profile]
The input profile can be generated by the ABI Monitor tool. All manual edits in the profile will be preserved after re-generating it by the ABI Monitor.
The home page of the output report is: timeline/LIB_NAME/index.html
EXAMPLES:
abi-tracker -build libssh.json
abi-tracker -rebuild -target abireport -v 0.7.0 libssh.json
GRAPH:
abi-tracker -build -t graph libssh.json
RSS:
abi-tracker -build -rss libssh.json
CRON JOB:
abi-monitor -get -build-new [profile]
abi-tracker -build [profile]
PROFILE FORMAT:
{
"Name": "SHORT LIBRARY NAME",
"Maintainer": "MAINTAINER NAME",
"SourceUrl": "URL TO DOWNLOAD PACKAGES",
"Git": "GIT ADDRESS TO CLONE",
"Versions": [
{
"Number": "VERSION NUMBER",
"Installed": "INSTALL TREE PATH",
"Source": "SOURCE PACKAGE PATH",
"Changelog": "CHANGELOG: On/Off",
"HeadersDiff": "HEADERS DIFF: On/Off",
"PkgDiff": "PACKAGE DIFF: On/Off",
"ABIView": "ABI VIEW: On/Off",
"ABIDiff": "ABI DIFF: On/Off"
},
...
{
...
}]
}
PROFILE EXAMPLE:
{
"Name": "libssh",
"Maintainer": "Andrey P.",
"SourceUrl": "https://red.libssh.org/projects/libssh/files",
"Git": "https://git.libssh.org/projects/libssh.git",
"Versions": [
{
"Number": "0.7.0",
"Installed": "installed/libssh/0.7.0",
"Source": "src/libssh/0.7.0/libssh-0.7.0.tar.xz",
"Changelog": "On",
"HeadersDiff": "On",
"PkgDiff": "On",
"ABIView": "Off",
"ABIDiff": "Off"
},
{
"Number": "0.6.5",
"Installed": "installed/libssh/0.6.5",
"Source": "src/libssh/0.6.5/libssh-0.6.5.tar.xz",
"Changelog": "On",
"HeadersDiff": "On",
"PkgDiff": "On",
"ABIView": "Off",
"ABIDiff": "Off"
},
...
{
"Number": "0.5.2",
"Installed": "installed/libssh/0.5.2",
"Source": "src/libssh/0.5.2/libssh-0.5.2.tar.xz",
"Changelog": "On",
"HeadersDiff": "On",
"PkgDiff": "On",
"ABIView": "Off",
"ABIDiff": "Off"
}]
}
See more profile examples in this directory: https://github.com/lvc/upstream-tracker/tree/master/profile
ADV. OPTIONS:
If you want to allow users to connect the maintainer of the tracker then you can set "MaintainerUrl" option.
To skip checking of some objects in the install tree of a library please define "SkipObjects": ["O1", ..., "On"] option.
The name of the analysed library in the title can be changed by "Title" option.
ADV. OPTIONS OF A VERSION:
To hide some version in the report you can define "Deleted" option.
ADV. USAGE:
For advanced usage, see output of --help option.
Enjoy!
|
