From d984025738e4682141d1bfee6f29ba42b82e7dec Mon Sep 17 00:00:00 2001 From: Roger Pack Date: Mon, 5 Dec 2022 23:27:25 -0700 Subject: Move platform-specific README files to doc/platforms Issue #515 (bdwgc). Make doc folder less overwhelming by moving platform specific docs to their own folder. * Makefile.am (dist_doc_DATA): Change doc/README.* to doc/platforms/README.* for README.DGUX386, README.Mac, README.OS2, README.aix, README.amiga, README.arm.cross, README.darwin, README.emscripten, README.ews4800, README.hp, README.linux, README.sgi, README.solaris2, README.symbian, README.uts, README.win32, README.win64. * README.md (General Description, Installation and Portability): Update links to README.win32, README.win64 and README.* files. * doc/debugging.md (Bus Errors and Segmentation Violations): Put README.win32 in quotes (to match that in other .md files). * doc/README.DGUX386: Move to doc/platforms folder. * doc/README.Mac: Likewise. * doc/README.OS2: Likewise. * doc/README.aix: Likewise. * doc/README.amiga: Likewise. * doc/README.arm.cross: Likewise. * doc/README.darwin: Likewise. * doc/README.emscripten: Likewise. * doc/README.ews4800: Likewise. * doc/README.hp: Likewise. * doc/README.linux: Likewise. * doc/README.sgi: Likewise. * doc/README.solaris2: Likewise. * doc/README.symbian: Likewise. * doc/README.uts: Likewise. * doc/README.win32: Likewise. * doc/README.win64: Likewise. * doc/simple_example.md (Other platforms): Replace doc/README.xxx to doc/platforms folder. --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e34fda2c..58662504 100644 --- a/README.md +++ b/README.md @@ -144,12 +144,12 @@ areas that are associated with dynamic libraries. This is easy to remedy if you know how to find those data areas on your operating system (see `GC_add_roots`). Code for doing this under SunOS, IRIX 5.X and 6.X, HP/UX, Alpha OSF/1, Linux, and Win32 is included and used by default. -(See [README.win32](doc/README.win32) and [README.win64](doc/README.win64) -for Windows details.) On other systems, pointers from dynamic library data -areas may not be considered by the collector. If you're writing a program -that depends on the collector scanning dynamic library data areas, it may -be a good idea to include at least one call to `GC_is_visible` to ensure -that those areas are visible to the collector. +(See [README.win32](doc/platforms/README.win32) and +[README.win64](doc/platforms/README.win64) for Windows details.) On other +systems, pointers from dynamic library data areas may not be considered by the +collector. If you're writing a program that depends on the collector scanning +dynamic library data areas, it may be a good idea to include at least one call +to `GC_is_visible` to ensure that those areas are visible to the collector. Note that the garbage collector does not need to be informed of shared read-only data. However, if the shared library mechanism can introduce @@ -223,8 +223,8 @@ with a single compiler invocation, like this: On Windows, CMake could be used to build the library as described above or by typing `nmake -f NT_MAKEFILE`, this assumes you have Microsoft command-line -tools installed and suitably configured. See [README.win32](doc/README.win32) -for details. +tools installed and suitably configured. See +[README.win32](doc/platforms/README.win32) for details. The library is built with threads support on (i.e. for thread-safe operation) by default, unless `--disable-threads` is passed to `./configure` (or @@ -262,8 +262,8 @@ The collector currently is designed to run essentially unmodified on machines that use a flat 32-bit or 64-bit address space. That includes the vast majority of Workstations and x86 (i386 or later) PCs. -In a few cases (OS/2, Win32) a separate makefile is supplied; these have -a separate host-specific doc/README.* file. +In a few cases (e.g., OS/2, Win32) a separate makefile is supplied; these have +a separate host-specific doc/platforms/README.* file. Dynamic libraries are completely supported only under SunOS/Solaris, (and even that support is not functional on the last Sun 3 release), -- cgit v1.2.1