summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIvan Maidanski <ivmai@mail.ru>2023-01-26 07:32:47 +0300
committerIvan Maidanski <ivmai@mail.ru>2023-01-26 07:53:41 +0300
commitd389c2d7f08ab48e7b6ec1a22c2afe9d201f5b12 (patch)
treede1e09811741f697ac3bd557af06c402390be641 /README.md
parenta8d383792100cb9958b430498e5a49ea4c4c2b9f (diff)
downloadbdwgc-d389c2d7f08ab48e7b6ec1a22c2afe9d201f5b12.tar.gz
Rename doc folder to docs
* CMakeLists.txt [enable_docs] (CMAKE_INSTALL_DOCDIR): Rename doc folder to docs. * Makefile.am [ENABLE_DOCS] (docdocdir, dist_docdocs_DATA, dist_docdocsplatforms_DATA): Likewise. * Makefile.direct (CXXFLAGS): Likewise. * README.md: Likewise. * docs/simple_example.md (Other platforms): Likewise. * Makefile.am [ENABLE_DOCS] (docdocdir): Rename to docdocsdir. * Makefile.am [ENABLE_DOCS] (dist_docdoc_DATA): Rename to dist_docdocs_DATA. * Makefile.am [ENABLE_DOCS] (docdocplatformsdir): Rename to docdocsplatformsdir. * Makefile.am [ENABLE_DOCS] (dist_docdocplatforms_DATA): Rename to dist_docdocsplatforms_DATA. * doc/README.autoconf: Move to docs folder. * doc/README.cmake: Likewise. * doc/README.cords: Likewise. * doc/README.environment: Likewise. * doc/README.macros: Likewise. * doc/debugging.md: Likewise. * doc/faq.md: Likewise. * doc/finalization.md: Likewise. * doc/gcdescr.md: Likewise. * doc/gcinterface.md: Likewise. * doc/leak.md: Likewise. * doc/overview.md: Likewise. * doc/porting.md: Likewise. * doc/scale.md: Likewise. * doc/simple_example.md: Likewise. * doc/tree.md: Likewise. * doc/platforms/README.aix: Move to docs/platforms folder. * doc/platforms/README.amiga: Likewise. * doc/platforms/README.arm_cross: Likewise. * doc/platforms/README.darwin: Likewise. * doc/platforms/README.dgux386: Likewise. * doc/platforms/README.emscripten: Likewise. * doc/platforms/README.ews4800: Likewise. * doc/platforms/README.hp: Likewise. * doc/platforms/README.linux: Likewise. * doc/platforms/README.mac: Likewise. * doc/platforms/README.os2: Likewise. * doc/platforms/README.sgi: Likewise. * doc/platforms/README.solaris2: Likewise. * doc/platforms/README.symbian: Likewise. * doc/platforms/README.uts: Likewise. * doc/platforms/README.win32: Likewise. * doc/platforms/README.win64: Likewise.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/README.md b/README.md
index 7545f54e..8c7e2c48 100644
--- a/README.md
+++ b/README.md
@@ -73,16 +73,16 @@ CSL 84-7). Doug McIlroy wrote a simpler fully conservative collector that
was part of version 8 UNIX (tm), but appears to not have received
widespread use.
-Rudimentary tools for use of the collector as a [leak detector](doc/leak.md)
+Rudimentary tools for use of the collector as a [leak detector](docs/leak.md)
are included, as is a fairly sophisticated string package "cord" that
-makes use of the collector. (See [README.cords](doc/README.cords) and
+makes use of the collector. (See [README.cords](docs/README.cords) and
H.-J. Boehm, R. Atkinson, and M. Plass, "Ropes: An Alternative to Strings",
Software Practice and Experience 25, 12 (December 1995), pp. 1315-1330.
This is very similar to the "rope" package in Xerox Cedar, or the "rope"
package in the SGI STL or the g++ distribution.)
Further collector documentation can be found in the
-[overview](doc/overview.md).
+[overview](docs/overview.md).
Some of the known uses of the collector are listed on the GitHub
[Known-clients](https://github.com/ivmai/bdwgc/wiki/Known-clients) page.
@@ -125,7 +125,7 @@ large objects to be disregarded, greatly reducing the probability of
accidental retention of large objects. For most purposes it seems
best to compile with `ALL_INTERIOR_POINTERS` and to use
`GC_malloc_ignore_off_page` if you get collector warnings from
-allocations of very large objects. See [here](doc/debugging.md) for details.
+allocations of very large objects. See [here](docs/debugging.md) for details.
_WARNING_: pointers inside memory allocated by the standard (system) `malloc`
are not seen by the garbage collector. Thus objects pointed to only from such
@@ -142,8 +142,8 @@ 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/platforms/README.win32) and
-[README.win64](doc/platforms/README.win64) for Windows details.) On other
+(See [README.win32](docs/platforms/README.win32) and
+[README.win64](docs/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
@@ -201,7 +201,7 @@ build of `master` branch of the collector could look like:
make check
Cloning of `libatomic_ops` is now optional provided the compiler supports
-atomic intrinsics. See [README.autoconf](doc/README.autoconf) for details.
+atomic intrinsics. See [README.autoconf](docs/README.autoconf) for details.
As noted above, alternatively, the collector could be built with CMake, like
this:
@@ -212,7 +212,7 @@ this:
cmake --build .
ctest
-See [README.cmake](doc/README.cmake) for details.
+See [README.cmake](docs/README.cmake) for details.
Finally, on most targets, the collector could be built and tested directly
with a single compiler invocation, like this:
@@ -222,14 +222,14 @@ 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/platforms/README.win32) for details.
+[README.win32](docs/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
`-Denable_threads=OFF` is passed to `cmake` tool).
The library could be configured more precisely during the build by defining
-the macros listed in [README.macros](doc/README.macros) file.
+the macros listed in [README.macros](docs/README.macros) file.
Below we focus on the collector build using classic makefile. For the
Makefile.direct-based process, typing `make check` instead of `make` will
@@ -261,7 +261,7 @@ 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 (e.g., OS/2, Win32) a separate makefile is supplied; these have
-a separate host-specific doc/platforms/README.* file.
+a separate host-specific docs/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),
@@ -289,7 +289,7 @@ or 64 bit addresses will require a major effort. A port to plain MSDOS
or win16 is hard.
For machines not already mentioned, or for nonstandard compilers,
-some porting suggestions are provided [here](doc/porting.md).
+some porting suggestions are provided [here](docs/porting.md).
## The C Interface to the Allocator
@@ -404,7 +404,7 @@ distribution. If you intend to use this, type
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 (gccpp) or the second one (gctba), but not both. See gc_cpp.h and
-[here](doc/gcinterface.md) for the definition of the interface.
+[here](docs/gcinterface.md) for the definition of the interface.
This interface tries to approximate the Ellis-Detlefs C++ garbage collection
proposal without compiler changes.