revert WA to merge to master
[dyninst.git] / parseAPI / README.md
1 # ParseAPI
2
3 ## Branch states
4
5 | Branch                                  | Status        | Notes                                              |
6 | --------------------------------------- |:-------------:|:--------------------------------------------------:|
7 | master                                  | stable        | No open issues                                     |
8
9 This is release 9.1 of the ParseAPI. Currently, this library is
10 available for the x86[_64]/Linux, x86/Windows, and
11 POWER/Linux platforms.
12
13 Documentation for the API can be found at
14
15     http://www.dyninst.org/
16
17 as well as in the doc/ subdirectory.
18
19
20 ## Prerequisites
21
22 The ParseAPI is a component of the Dyninst system, and depends on two other
23 components: the SymtabAPI binary format library and the InstructionAPI
24 disassembly library. Both of these components should have been included in the
25 package containing the ParseAPI; if not, they can be obtained from the
26 dyninst.org website.
27
28 The SymtabAPI has further dependencies depending on the platform, including
29 libelf and libdwarf. See the SymtabAPI documentation for details.
30
31
32 ## Compiling the library
33
34 See the top-level INSTALL file for build information.
35
36 -----------------------------------------------------------------------------
37
38 This software is derived from the Paradyn system and therefore subject to
39 the same copyright.  A copy of the Paradyn copyright appears at the end of
40 this file.
41
42         The Dyninst API Team
43         12/9/2015
44
45 ----------------------- Start of Paradyn Copyright --------------------------
46 See the dyninst/COPYRIGHT file for copyright information.
47  
48 We provide the Paradyn Tools (below described as "Paradyn")
49 on an AS IS basis, and do not warrant its validity or performance.
50 We reserve the right to update, modify, or discontinue this
51 software at any time.  We shall have no obligation to supply such
52 updates or modifications or any other form of support to you.
53  
54 By your use of Paradyn, you understand and agree that we (or any
55 other person or entity with proprietary rights in Paradyn) are
56 under no obligation to provide either maintenance services,
57 update services, notices of latent defects, or correction of
58 defects for Paradyn.
59
60 This library is free software; you can redistribute it and/or
61 modify it under the terms of the GNU Lesser General Public
62 License as published by the Free Software Foundation; either
63 version 2.1 of the License, or (at your option) any later version.
64
65 This library is distributed in the hope that it will be useful,
66 but WITHOUT ANY WARRANTY; without even the implied warranty of
67 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
68 Lesser General Public License for more details.
69
70 You should have received a copy of the GNU Lesser General Public
71 License along with this library; if not, write to the Free Software
72 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
73