implemented Setup.hs to build boehm cpp libs and install them;
[hs-boehmgc.git] / gc-7.2 / libatomic_ops / README
1 Synopsis
2 ========
3
4 This package provides semi-portable access to hardware provided
5 atomic memory operations.  These might allow you to write code:
6
7 - That does more interesting things in signal handlers.
8 - Makes more effective use of multiprocessors by allowing you to write
9   clever lock-free code.  Note that such code is very difficult to get
10   right, and will unavoidably be less portable than lock-based code.  It
11   is also not always faster than lock-based code.  But it may occasionally
12   be a large performance win.
13 - To experiment with new and much better thread programming paradigms, etc.
14
15 For details and licensing restrictions see the files in the doc
16 subdirectory.
17
18 This is version 7.2d of libatomic_ops.
19
20 You might find a more recent version of this at
21
22 http://www.hpl.hp.com/personal/Hans_Boehm/gc
23
24 or
25
26 http://www.hpl.hp.com/research/linux/atomic_ops/
27
28
29 Installation and Usage
30 ======================
31
32 The configuration and build scripts for this package were generated by
33 Automake/Autoconf.  "./configure --prefix=<install dir>; make; make install"
34 in this directory should work.  For a more customized build, see "INSTALL"
35 and the output of "./configure --help".
36
37 Note that much of the content of this library is in the header files.
38 However, two small libraries are built and installed:
39
40 - libatomic_ops.a is a support library, which is not needed on some platforms.
41   This is intended to be usable, under some mild restrictions, in free or
42   proprietary code, as are all the header files.  See doc/LICENSING.txt.
43 - libatomic_ops_gpl.a contains some higher level facilities.  This code is
44   currently covered by the GPL.  The contents currently correspond to
45   the headers atomic_ops_stack.h and atomic_ops_malloc.h.
46
47
48 Platform Specific Notes
49 =======================
50
51 Win32/64: src/Makefile.msft contains a very simple Makefile for building
52 and running tests and building the gpl library.  The core atomic_ops
53 implementation is entirely in header files.
54
55 HP-UX/PA-RISC: aCC -Ae won't work as a C compiler, since it doesn't support
56 inline assembly code.  Use cc.