Debian Codegraph @

INSTALL

raw
1
2 Copyright (C) 2009-2011 Institute for System Programming, RAS
3 Copyright (C) 2011-2015 Andrey Ponomarenko's ABI Laboratory
4 All rights reserved.
5
6
7 RELEASE INFORMATION
8
9 Project: API Sanity Checker
10 Version: 1.98.7
11 Date: 2015-09-08
12
13
14 This file explains how to install and setup environment
15 for the tool in your computer.
16
17
18 Content:
19
20 1. Requirements for Linux and FreeBSD
21 2. Requirements for Mac OS X
22 3. Requirements for MS Windows
23 4. Configuring and Installing
24 5. Running the Tool
25
26
27 1. REQUIREMENTS FOR LINUX AND FREEBSD
28 =====================================
29
30 1. ABI Compliance Checker (1.98.7 or newer)
31 2. G++ (3.0-4.7, 4.8.3, 4.9 or newer)
32 3. GNU Binutils (c++filt, readelf, objdump)
33 4. Perl 5 (5.8 or newer)
34 5. Ctags (5.8 or newer)
35
36
37
38 2. REQUIREMENTS FOR MAC OS X
39 ============================
40
41 1. ABI Compliance Checker (1.98.7 or newer)
42 2. Xcode (gcc, c++filt, nm)
43 3. Ctags (5.8 or newer)
44
45
46
47 3. REQUIREMENTS FOR MS WINDOWS
48 ==============================
49
50 1. ABI Compliance Checker (1.98.7 or newer)
51 2. MinGW (3.0-4.7, 4.8.3, 4.9 or newer)
52 3. MS Visual C++ (dumpbin, undname, cl)
53 4. Active Perl 5 (5.8 or newer)
54 5. Ctags (5.8 or newer)
55
56 3.1 Setup environment
57
58 1. Add tool locations to the PATH environment variable
59 2. Run vsvars32.bat script (C:\Microsoft Visual Studio 9.0\Common7\Tools\)
60
61
62
63 4. CONFIGURING AND INSTALLING
64 ===================================================
65
66 This command will install an api-sanity-checker program in the
67 PREFIX/bin system directory:
68
69 sudo make install prefix=PREFIX [/usr, /usr/local, ...]
70
71 4.1 Remove
72
73 sudo make uninstall prefix=PREFIX
74
75
76
77 5. RUNNING THE TOOL
78 ===================
79
80 1. Create an XML-descriptor
81 for your library (VERSION.xml):
82
83 <version>
84 1.0
85 </version>
86
87 <headers>
88 /path1/to/header(s)/
89 /path2/to/header(s)/
90 ...
91 </headers>
92
93 <libs>
94 /path1/to/library(ies)/
95 /path2/to/library(ies)/
96 ...
97 </libs>
98
99 2. api-sanity-checker -lib NAME -d VERSION.xml -gen -build -run
100 3. For advanced usage, see doc/Readme.html or --help option
101
102
103
104 Enjoy!