boehm-gc/README.QUICK

   1 Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
   2 Copyright (c) 1991-1994 by Xerox Corporation.  All rights reserved.
   3
   4 THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   5 OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   6
   7 Permission is hereby granted to use or copy this program
   8 for any purpose,  provided the above notices are retained on all copies.
   9 Permission to modify the code and to distribute modified code is granted,
  10 provided the above notices are retained, and a notice that the code was
  11 modified is included with the above copyright notice.
  12
  13
  14 For more details and the names of other contributors, see the
  15 README file and gc.h.  This file describes typical use of
  16 the collector on a machine that is already supported.
  17
  18 INSTALLATION:
  19 Under UN*X, type "make test".  Under OS/2 or Windows NT, copy the
  20 appropriate makefile to MAKEFILE, read it, and type "nmake test".
  21 Read the machine specific README if one exists.  The only way to
  22 develop code with the collector for Windows 3.1 is to develop under
  23 Windows NT, and then to use win32S.
  24
  25 If you wish to use the cord (structured string) library type
  26 "make cords". (This requires an ANSI C compiler.  You may need
  27 to redefine CC in the Makefile.)
  28
  29 If you wish to use the collector from C++, type
  30 "make c++".  These add further files to gc.a and to the include
  31 subdirectory.  See cord/cord.h and gc_c++.h.
  32
  33 TYPICAL USE:
  34 Include "gc.h" from this directory.  Link against the appropriate library
  35 ("gc.a" under UN*X).  Replace calls to malloc by calls to GC_MALLOC,
  36 and calls to realloc by calls to GC_REALLOC.  If the object is known
  37 to never contain pointers, use GC_MALLOC_ATOMIC instead of
  38 GC_MALLOC.
  39
  40 Define GC_DEBUG before including gc.h for additional checking.
  41