2004-08-14 Casey Marshall <csm@gnu.org>
[official-gcc.git] / boehm-gc / doc / README.autoconf
blob53fcf5a50b3f8abb71468c521590e02036d75a59
1 As of GC6.0alpha8, we attempt to support GNU-style builds based on automake,
2 autoconf and libtool.  This is based almost entirely on Tom Tromey's work
3 with gcj.
5 To build and install libraries use
7 configure; make; make install
9 The advantages of this process are:
11 1) It should eventually do a better job of automatically determining the
12 right compiler to use, etc.  It probably already does in some cases.
14 2) It tries to automatically set a good set of default GC parameters for
15 the platform (e.g. thread support).  It provides an easier way to configure
16 some of the others.
18 3) It integrates better with other projects using a GNU-style build process.
20 4) It builds both dynamic and static libraries.
22 The known disadvantages are:
24 1) The build scripts are much more complex and harder to debug (though largely
25 standard).  I don't understand them all, and there's probably lots of redundant
26 stuff.
28 2) It probably doesn't work on all Un*x-like platforms yet.  It probably will
29 never work on the rest.
31 3) The scripts are not yet complete.  Some of the standard GNU targets don't
32 yet work.  (Corrections/additions are very welcome.)
34 The distribution should contain all files needed to run "configure" and "make",
35 as well as the sources needed to regenerate the derived files.  (If I missed
36 some, please let me know.)
38 Note that the distribution comes with a "Makefile" which will be overwritten
39 by "configure" with one that is not at all equiavelent to the original.  The
40 distribution contains a copy of the original "Makefile" in "Makefile.direct". 
42 Important options to configure:
44   --prefix=PREFIX         install architecture-independent files in PREFIX
45                           [/usr/local]
46   --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
47                           [same as prefix]
48   --enable-threads=TYPE   choose threading package
49   --enable-parallel-mark  parallelize marking and free list construction
50   --enable-full-debug   include full support for pointer backtracing etc.
52 Unless --prefix is set (or --exec-prefix or one of the more obscure options),
53 make install will install libgc.a and libgc.so in /usr/local/bin, which
54 would typically require the "make install" to be run as root.
56 Most commonly --enable-threads=posix or will be needed.  --enable-parallel-mark
57 is recommended for multiprocessors if it is supported on the platform.