diff options
author | Ivan Maidanski <ivmai@mail.ru> | 2021-11-24 09:47:29 +0300 |
---|---|---|
committer | Ivan Maidanski <ivmai@mail.ru> | 2021-11-24 19:49:17 +0300 |
commit | eede547e2cd4dde96053f987bfb3a7ea3d36f032 (patch) | |
tree | 395103468b614f385605d5bf984c92cd61fa405a /LICENSE | |
parent | 9ed0cfb002faf696409da7ec80ab6c8d6c149fa2 (diff) | |
download | bdwgc-eede547e2cd4dde96053f987bfb3a7ea3d36f032.tar.gz |
Move non-license info from LICENSE file to README
* LICENSE: Remove INSTALLATION, TYPICAL USE, WARNINGS sections (i.e.,
remove all non-license information).
* README.md (Overview): Add link to README.cords; some other minor changes;
reformat text.
* README.md (General Description): Add link to README.win32 and
README.win64; reformat text.
* README.md (Installation and Portability): Mention CMake before providing
exact build commands; add reference to README.cmake and README.macros;
mention how to build the collector on Windows; mention that threads are on
be default; mention how to build cord library with Makefile.direct mention
that Symbian has a separate makefile.
* README.md (The C++ Interface to the Allocator): Copy information about
building the C++ GC libraries from LICENSE; add link to gcinterface.md.
* doc/README.cords: Copy information about cord library building from
LICENSE file.
Diffstat (limited to 'LICENSE')
-rw-r--r-- | LICENSE | 68 |
1 files changed, 0 insertions, 68 deletions
@@ -28,71 +28,3 @@ to use the GNU-style build procedure come with a modified GPL license that appears not to significantly restrict use of the collector, though use of those files for a purpose other than building the collector may require the resulting code to be covered by the GPL. - -For more details and the names of other contributors, see the README.md, -doc/README.*, AUTHORS and include/gc.h files. These files describe typical -use of the collector on a machine that is already supported. - -For the version number, see README.md or include/gc_version.h files. - -INSTALLATION: -Under UN*X, Linux, Cygwin: -Alternative 1 (the old way): type "make -f Makefile.direct check". - Link against libgc.a. - -Alternative 2 (the new way): type - "./configure --prefix=<dir>; make; make check; make install". - Link against <dir>/lib/libgc.a or <dir>/lib/libgc.so. - See doc/README.autoconf for details. - -Alternative 3 (another new way): type - "mkdir out; cd out; cmake ..; cmake --build ." - See doc/README.cmake for details. - -Under Windows 95, 98, Me, NT, or 2000: -copy the appropriate makefile to MAKEFILE, read it, and type "nmake check". -(Under Windows, this assumes you have Microsoft command-line tools -installed, and suitably configured.) -Read the machine specific README.XXX in the doc directory if one exists. - -If you need thread support, you should define GC_THREADS as described in -doc/README.macros (configure defines this implicitly unless --disable-threads -option is given). - -If you wish to use the cord (structured string) library with the stand-alone -Makefile.direct, type "make -f Makefile.direct cords". (You may need to -override CC specified in the Makefile. The CORD_printf implementation in -cordprnt.c is known to be less than perfectly portable. The rest of the -package should still work.) See include/cord.h for the API. - -If you wish to use the collector from C++, type "make c++", or use ---enable-cplusplus with the configure script. This creates libgccpp.a and -libgctba.a files, or their shared library equivalents (libgccpp.so and -libgctba.so). You should link with either the first or the second one, but -not both. See include/gc_cpp.h and doc/gcinterface.md. - -TYPICAL USE: -Include "gc.h" from the include subdirectory. Link against the -appropriate library ("libgc.a" under UN*X). Replace calls to malloc -by calls to GC_MALLOC, and calls to realloc by calls to GC_REALLOC. -If the object is known to never contain pointers, use GC_MALLOC_ATOMIC -instead of GC_MALLOC. - -Define GC_DEBUG before including gc.h for additional checking. - -More documentation on the collector interface can be found in README.md, -doc/gcinterface.md, include/gc.h, and other files in the doc directory. - -WARNINGS: - -Do not store the only pointer to an object in memory allocated -with system malloc, since the collector usually does not scan -memory allocated in this way. - -Use with threads may be supported on your system, but requires the collector -to be built with thread support. See Makefile.am or Makefile.direct. -The collector does not guarantee to scan thread-local storage (e.g. of the -kind accessed with pthread_getspecific()). The collector does scan -thread stacks though, so generally the best solution is to ensure that -any pointers stored in thread-local storage are also stored on the -thread's stack for the duration of their lifetime. |