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.

21 files changed, 31 insertions, 31 deletions

diff --git a/Makefile.am b/Makefile.am
index 5425fb43..4076f9ba 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -216,28 +216,28 @@ dist_doc_DATA = \
     AUTHORS \
     LICENSE \
     README.md \
-    doc/README.DGUX386 \
-    doc/README.Mac \
-    doc/README.OS2 \
-    doc/README.aix \
-    doc/README.amiga \
-    doc/README.arm.cross \
+    doc/platforms/README.DGUX386 \
+    doc/platforms/README.Mac \
+    doc/platforms/README.OS2 \
+    doc/platforms/README.aix \
+    doc/platforms/README.amiga \
+    doc/platforms/README.arm.cross \
+    doc/platforms/README.darwin \
+    doc/platforms/README.emscripten \
+    doc/platforms/README.ews4800 \
+    doc/platforms/README.hp \
+    doc/platforms/README.linux \
+    doc/platforms/README.sgi \
+    doc/platforms/README.solaris2 \
+    doc/platforms/README.symbian \
+    doc/platforms/README.uts \
+    doc/platforms/README.win32 \
+    doc/platforms/README.win64 \
     doc/README.autoconf \
     doc/README.cmake \
     doc/README.cords \
-    doc/README.darwin \
-    doc/README.emscripten \
     doc/README.environment \
-    doc/README.ews4800 \
-    doc/README.hp \
-    doc/README.linux \
     doc/README.macros \
-    doc/README.sgi \
-    doc/README.solaris2 \
-    doc/README.symbian \
-    doc/README.uts \
-    doc/README.win32 \
-    doc/README.win64 \
     doc/debugging.md \
     doc/finalization.md \
     doc/gcdescr.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),
diff --git a/doc/debugging.md b/doc/debugging.md
index 9de30804..4b2ef6e4 100644
--- a/doc/debugging.md
+++ b/doc/debugging.md
@@ -21,7 +21,7 @@ there was not other handler previously installed.
 
 We recommend debugging without incremental collection if possible. (This
 applies directly to UNIX systems. Debugging with incremental collection under
-Win32 is worse. See README.win32.)
+Win32 is worse. See `README.win32` file.)
 
 If the application generates an unhandled SIGSEGV or equivalent, it may often
 be easiest to set the environment variable `GC_LOOP_ON_ABORT`. On many
diff --git a/doc/README.DGUX386 b/doc/platforms/README.DGUX386
index 0c5b077c..0c5b077c 100644
--- a/doc/README.DGUX386
+++ b/doc/platforms/README.DGUX386
diff --git a/doc/README.Mac b/doc/platforms/README.Mac
index 100746b1..100746b1 100644
--- a/doc/README.Mac
+++ b/doc/platforms/README.Mac
diff --git a/doc/README.OS2 b/doc/platforms/README.OS2
index fbd9c811..fbd9c811 100644
--- a/doc/README.OS2
+++ b/doc/platforms/README.OS2
diff --git a/doc/README.aix b/doc/platforms/README.aix
index f5630b20..f5630b20 100644
--- a/doc/README.aix
+++ b/doc/platforms/README.aix
diff --git a/doc/README.amiga b/doc/platforms/README.amiga
index 6dc6378c..6dc6378c 100644
--- a/doc/README.amiga
+++ b/doc/platforms/README.amiga
diff --git a/doc/README.arm.cross b/doc/platforms/README.arm.cross
index 9e60dda7..9e60dda7 100644
--- a/doc/README.arm.cross
+++ b/doc/platforms/README.arm.cross
diff --git a/doc/README.darwin b/doc/platforms/README.darwin
index 32a5fb17..32a5fb17 100644
--- a/doc/README.darwin
+++ b/doc/platforms/README.darwin
diff --git a/doc/README.emscripten b/doc/platforms/README.emscripten
index c869f19a..c869f19a 100644
--- a/doc/README.emscripten
+++ b/doc/platforms/README.emscripten
diff --git a/doc/README.ews4800 b/doc/platforms/README.ews4800
index 83e8b1e0..83e8b1e0 100644
--- a/doc/README.ews4800
+++ b/doc/platforms/README.ews4800
diff --git a/doc/README.hp b/doc/platforms/README.hp
index cc31b18d..cc31b18d 100644
--- a/doc/README.hp
+++ b/doc/platforms/README.hp
diff --git a/doc/README.linux b/doc/platforms/README.linux
index c9ced481..c9ced481 100644
--- a/doc/README.linux
+++ b/doc/platforms/README.linux
diff --git a/doc/README.sgi b/doc/platforms/README.sgi
index 4258dce4..4258dce4 100644
--- a/doc/README.sgi
+++ b/doc/platforms/README.sgi
diff --git a/doc/README.solaris2 b/doc/platforms/README.solaris2
index 8eb4b9c2..8eb4b9c2 100644
--- a/doc/README.solaris2
+++ b/doc/platforms/README.solaris2
diff --git a/doc/README.symbian b/doc/platforms/README.symbian
index c3e0c833..c3e0c833 100644
--- a/doc/README.symbian
+++ b/doc/platforms/README.symbian
diff --git a/doc/README.uts b/doc/platforms/README.uts
index 6be49667..6be49667 100644
--- a/doc/README.uts
+++ b/doc/platforms/README.uts
diff --git a/doc/README.win32 b/doc/platforms/README.win32
index 21d14181..21d14181 100644
--- a/doc/README.win32
+++ b/doc/platforms/README.win32
diff --git a/doc/README.win64 b/doc/platforms/README.win64
index ed30665e..ed30665e 100644
--- a/doc/README.win64
+++ b/doc/platforms/README.win64
diff --git a/doc/simple_example.md b/doc/simple_example.md
index d24c9a08..388a8377 100644
--- a/doc/simple_example.md
+++ b/doc/simple_example.md
@@ -31,8 +31,8 @@ a basic correctness test which usually takes well under a minute.
 ### Other platforms
 
 On non-Unix, non-Linux platforms, the collector is usually built by copying
-the appropriate makefile (see the platform-specific README in doc/README.xxx
-in the distribution) to the file "Makefile", and then typing `make` (or
+the appropriate makefile (see the platform-specific README in `doc/platforms`
+folder in the distribution) to the file `Makefile`, and then typing `make` (or
 `nmake` or ...). This builds the library in the source tree. You may want
 to move it and the files in the include directory to a more convenient place.
 
@@ -179,4 +179,4 @@ The executable can of course be run normally, e.g. by typing:
 
 The operation of the collector is affected by a number of environment
 variables. For example, setting `GC_PRINT_STATS` produces some GC statistics
-on stdout. See `README.environment` in the distribution for details.
+on stdout. See `README.environment` file in the distribution for details.