From: Ivan Maidanski Date: Mon, 26 Dec 2011 07:18:55 +0000 (+0400) Subject: Localize references in 'doc' html files X-Git-Tag: gc7_3alpha2~273 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d8468a96d28862fa9fd8da9356d85166e7750e1c;p=gc Localize references in 'doc' html files * doc/gcinterface.html: Set "text/plain" type for references to GC header files; make some absolute references to local (for HTML files existing in doc folder). * doc/overview.html: Likewise. --- diff --git a/doc/gcinterface.html b/doc/gcinterface.html index a9faee15..83574bb8 100644 --- a/doc/gcinterface.html +++ b/doc/gcinterface.html @@ -25,7 +25,7 @@ It is not a complete definition of the interface. It describes only the most commonly used functionality, approximately in decreasing order of frequency of use. The full interface is described in -gc.h +gc.h or gc.h in the distribution.

Clients should include gc.h. @@ -68,7 +68,7 @@ This is the preferred way to allocate strings, floating point arrays, bitmaps, etc. More precise information about pointer locations can be communicated to the collector using the interface in -gc_typed.h in the distribution. +gc_typed.h in the distribution.

void * GC_MALLOC_UNCOLLECTABLE(size_t nbytes)

Identical to GC_MALLOC, @@ -126,7 +126,7 @@ running time. It will improve response on a platform that either has suitable support in the garbage collector (Linux and most Unix versions, win32 if the collector was suitably built) or if "stubborn" allocation is used (see -gc.h). +gc.h). On many platforms this interacts poorly with system calls that write to the garbage collected heap.

GC_warn_proc GC_set_warn_proc(GC_warn_proc p) @@ -135,7 +135,7 @@ Replace the default procedure used by the collector to print warnings. The collector may otherwise write to stderr, most commonly because GC_malloc was used in a situation in which GC_malloc_ignore_off_page would have been more -appropriate. See gc.h for details. +appropriate. See gc.h for details.

void GC_REGISTER_FINALIZER(...)

Register a function to be called when an object becomes inaccessible. @@ -144,7 +144,7 @@ This is often useful as a backup method for releasing system resources inaccessible. It is not an acceptable method to perform actions that must be performed in a timely fashion. -See gc.h for details of the interface. +See gc.h for details of the interface. See here for a more detailed discussion of the design.

@@ -170,7 +170,7 @@ or gc_gcj.h.

The collector distribution also includes a string package that takes advantage of the collector. For details see -cord.h +cord.h

C++ Interface

The C++ interface is implemented as a thin layer on the C interface. @@ -255,7 +255,7 @@ For an example, click gc_cpp.h. +For details see gc_cpp.h.

Linking against libgccpp in addition to the gc library overrides ::new (and friends) to allocate traceable memory but uncollectable @@ -264,7 +264,7 @@ memory.

C interface

It is also possible to use the C interface from -gc.h directly. +gc.h directly. On platforms which use malloc to implement ::new, it should usually be possible to use a version of the collector that has been compiled as a malloc replacement. It is also possible to replace ::new and other allocation diff --git a/doc/overview.html b/doc/overview.html index 564ec3e8..de589235 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -3,10 +3,10 @@ - + - + @@ -37,17 +37,17 @@ without explicitly deallocating memory that is no longer useful. The collector automatically recycles memory when it determines that it can no longer be otherwise accessed. A simple example of such a use is given -here. +here.

The collector is also used by a number of programming language implementations that either use C as intermediate code, want to facilitate easier interoperation with C libraries, or just prefer the simple collector interface. For a more detailed description of the interface, see -here. +here.

Alternatively, the garbage collector may be used as -a leak detector +a leak detector for C or C++ programs, though that is not its primary goal.

Typically several versions will be available. @@ -130,7 +130,7 @@ based on this one. Their collector takes advantage of multiple processors during a collection. Starting with collector version 6.0alpha1 we also do this, though with more modest processor scalability goals. Our approach is discussed briefly in -scale.html. +scale.html.

Some Collector Details

The collector uses a mark-sweep algorithm. It provides incremental and generational @@ -144,10 +144,10 @@ information is provided, but it is usually used without such information. ee the README and gc.h files in the distribution for more details.

-For an overview of the implementation, see here. +For an overview of the implementation, see here.

The garbage collector distribution includes a C string -(cord) package that provides +(cord) package that provides for fast concatenation and substring operations on long strings. A simple curses- and win32-based editor that represents the entire file as a cord is included as a @@ -194,7 +194,7 @@ and the underlying design decisions at a higher level.

(Some of the lower level details can be found -here.) +here.)

The first one is not available electronically due to copyright considerations. Most of the others are @@ -347,27 +347,27 @@ system. vector graphics language.