[3bbd5fe9] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[3bbd5fe9] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[63e2629] | 7 | <!ENTITY gc-download-http "http://www.hboehm.info/gc/gc_source/gc-&gc-version;.tar.gz">
|
---|
[8057fc4] | 8 | <!ENTITY gc-download-ftp " ">
|
---|
[a255f1c9] | 9 | <!ENTITY gc-md5sum "bf46ccbdaccfa3186c2ab87191c8855a">
|
---|
[663957f] | 10 | <!ENTITY gc-size "1.1 MB">
|
---|
[9f574bb] | 11 | <!ENTITY gc-buildsize "13 MB (with tests)">
|
---|
| 12 | <!ENTITY gc-time "0.2 SBU (with tests)">
|
---|
[3bbd5fe9] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gc" xreflabel="GC-&gc-version;">
|
---|
| 16 | <?dbhtml filename="gc.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>GC-&gc-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="gc">
|
---|
| 26 | <primary sortas="a-GC">GC</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GC</title>
|
---|
| 31 |
|
---|
[b3bb56b] | 32 | <para>
|
---|
| 33 | The <application>GC</application> package contains the Boehm-Demers-Weiser
|
---|
| 34 | conservative garbage collector, which can be used as a garbage collecting
|
---|
| 35 | replacement for the C malloc function or C++ new operator. It allows you
|
---|
| 36 | to allocate memory basically as you normally would, without explicitly
|
---|
| 37 | deallocating memory that is no longer useful. The collector automatically
|
---|
| 38 | recycles memory when it determines that it can no longer be otherwise
|
---|
| 39 | accessed. The collector is also used by a number of programming language
|
---|
| 40 | implementations that either use C as intermediate code, want to facilitate
|
---|
| 41 | easier interoperation with C libraries, or just prefer the simple
|
---|
| 42 | collector interface. Alternatively, the garbage collector may be used as a
|
---|
| 43 | leak detector for C or C++ programs, though that is not its primary goal.
|
---|
| 44 | </para>
|
---|
| 45 |
|
---|
[410d9d0] | 46 | &lfs81_checked;
|
---|
[d4796f8b] | 47 |
|
---|
[3bbd5fe9] | 48 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 49 | <itemizedlist spacing="compact">
|
---|
| 50 | <listitem>
|
---|
[4355dbcf] | 51 | <para>
|
---|
| 52 | Download (HTTP): <ulink url="&gc-download-http;"/>
|
---|
| 53 | </para>
|
---|
[3bbd5fe9] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[4355dbcf] | 56 | <para>
|
---|
| 57 | Download (FTP): <ulink url="&gc-download-ftp;"/>
|
---|
| 58 | </para>
|
---|
[3bbd5fe9] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[4355dbcf] | 61 | <para>
|
---|
| 62 | Download MD5 sum: &gc-md5sum;
|
---|
| 63 | </para>
|
---|
[3bbd5fe9] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[4355dbcf] | 66 | <para>
|
---|
| 67 | Download size: &gc-size;
|
---|
| 68 | </para>
|
---|
[3bbd5fe9] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[4355dbcf] | 71 | <para>
|
---|
| 72 | Estimated disk space required: &gc-buildsize;
|
---|
| 73 | </para>
|
---|
[3bbd5fe9] | 74 | </listitem>
|
---|
| 75 | <listitem>
|
---|
[4355dbcf] | 76 | <para>
|
---|
| 77 | Estimated build time: &gc-time;
|
---|
| 78 | </para>
|
---|
[3bbd5fe9] | 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
| 81 |
|
---|
[663957f] | 82 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 83 | <para role="required">
|
---|
| 84 | <xref linkend="libatomic_ops"/>
|
---|
| 85 | </para>
|
---|
| 86 | <!-- (Gc contains a copy of
|
---|
[b3bb56b] | 87 | Libatomic_ops-&gc-version; which it will compile and statically link if
|
---|
[4355dbcf] | 88 | configure doesn't find Libatomic_ops installed on your system)
|
---|
[b3bb56b] | 89 | </para>
|
---|
[663957f] | 90 | -->
|
---|
[1039de3] | 91 |
|
---|
[b3bb56b] | 92 | <para condition="html" role="usernotes">
|
---|
| 93 | User Notes: <ulink url="&blfs-wiki;/gc"/>
|
---|
| 94 | </para>
|
---|
[3bbd5fe9] | 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of GC</title>
|
---|
| 99 |
|
---|
[b3bb56b] | 100 | <para>
|
---|
| 101 | Install <application>GC</application> by running the following commands:
|
---|
| 102 | </para>
|
---|
[3bbd5fe9] | 103 |
|
---|
[663957f] | 104 | <screen><userinput>sed -i 's#pkgdata#doc#' doc/doc.am &&
|
---|
[4355dbcf] | 105 | autoreconf -fi &&
|
---|
[1eb827c6] | 106 | ./configure --prefix=/usr \
|
---|
| 107 | --enable-cplusplus \
|
---|
| 108 | --disable-static \
|
---|
| 109 | --docdir=/usr/share/doc/gc-&gc-version; &&
|
---|
[3bbd5fe9] | 110 | make</userinput></screen>
|
---|
| 111 |
|
---|
[4355dbcf] | 112 | <para>
|
---|
| 113 | To test the results, issue: <command>make check</command>.
|
---|
| 114 | </para>
|
---|
[3bbd5fe9] | 115 |
|
---|
[b3bb56b] | 116 | <para>
|
---|
| 117 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 118 | </para>
|
---|
[3bbd5fe9] | 119 |
|
---|
| 120 | <screen role="root"><userinput>make install &&
|
---|
| 121 | install -v -m644 doc/gc.man /usr/share/man/man3/gc_malloc.3 &&
|
---|
[b1f16ca5] | 122 | ln -sfv gc_malloc.3 /usr/share/man/man3/gc.3</userinput></screen>
|
---|
[3bbd5fe9] | 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
| 127 |
|
---|
[4355dbcf] | 128 | <para>
|
---|
| 129 | <command>sed -i 's#pkgdata#doc#' doc/doc.am</command> and
|
---|
[f1d7196] | 130 | <parameter>--docdir=/usr/share/doc/gc-&gc-version;</parameter>:
|
---|
[4355dbcf] | 131 | These commands are used so the package will install the
|
---|
| 132 | documentation in a versioned directory.
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
| 136 | <command>autoreconf -fi</command>: This regenerates the
|
---|
| 137 | <command>configure</command> script and the
|
---|
| 138 | <filename>Makefile.in</filename> files.
|
---|
[b3bb56b] | 139 | </para>
|
---|
[3bbd5fe9] | 140 |
|
---|
[b3bb56b] | 141 | <para>
|
---|
| 142 | <parameter>--enable-cplusplus</parameter>: This parameter enables the
|
---|
[9f574bb] | 143 | building and installing of the C++ library along with the standard
|
---|
| 144 | C library.
|
---|
[b3bb56b] | 145 | </para>
|
---|
[4e143323] | 146 |
|
---|
| 147 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 148 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 149 |
|
---|
[3bbd5fe9] | 150 | </sect2>
|
---|
| 151 |
|
---|
| 152 | <sect2 role="content">
|
---|
| 153 | <title>Contents</title>
|
---|
| 154 |
|
---|
| 155 | <segmentedlist>
|
---|
[c3c56b2] | 156 | <segtitle>Installed Programs</segtitle>
|
---|
[3bbd5fe9] | 157 | <segtitle>Installed Libraries</segtitle>
|
---|
| 158 | <segtitle>Installed Directories</segtitle>
|
---|
| 159 |
|
---|
| 160 | <seglistitem>
|
---|
[c3c56b2] | 161 | <seg>
|
---|
| 162 | None
|
---|
| 163 | </seg>
|
---|
[b3bb56b] | 164 | <seg>
|
---|
[4e143323] | 165 | libcord.so, libgc.so and
|
---|
[b3bb56b] | 166 | libgccpp.so
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>
|
---|
| 169 | /usr/include/gc and
|
---|
[bfefc696] | 170 | /usr/share/doc/gc-&gc-version;
|
---|
[b3bb56b] | 171 | </seg>
|
---|
[3bbd5fe9] | 172 | </seglistitem>
|
---|
| 173 | </segmentedlist>
|
---|
| 174 |
|
---|
| 175 | <variablelist>
|
---|
| 176 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 177 | <?dbfo list-presentation="list"?>
|
---|
| 178 | <?dbhtml list-presentation="table"?>
|
---|
| 179 |
|
---|
| 180 | <varlistentry id="libgc">
|
---|
[4355dbcf] | 181 | <term><filename class="libraryfile">libgc.so</filename></term>
|
---|
[3bbd5fe9] | 182 | <listitem>
|
---|
[b3bb56b] | 183 | <para>
|
---|
| 184 | contains a C interface to the conservative garbage collector,
|
---|
| 185 | primarily designed to replace the C malloc function.
|
---|
| 186 | </para>
|
---|
[3bbd5fe9] | 187 | <indexterm zone="gc libgc">
|
---|
[b3bb56b] | 188 | <primary sortas="c-libgc">libgc.so</primary>
|
---|
[3bbd5fe9] | 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
| 192 |
|
---|
| 193 | <varlistentry id="libgccpp">
|
---|
[4355dbcf] | 194 | <term><filename class="libraryfile">libgccpp.so</filename></term>
|
---|
[3bbd5fe9] | 195 | <listitem>
|
---|
[b3bb56b] | 196 | <para>
|
---|
| 197 | contains a C++ interface to the conservative garbage collector.
|
---|
| 198 | </para>
|
---|
[3bbd5fe9] | 199 | <indexterm zone="gc libgccpp">
|
---|
[b3bb56b] | 200 | <primary sortas="c-libgccpp">libgccpp.so</primary>
|
---|
[3bbd5fe9] | 201 | </indexterm>
|
---|
| 202 | </listitem>
|
---|
| 203 | </varlistentry>
|
---|
[4e143323] | 204 |
|
---|
[3bbd5fe9] | 205 | </variablelist>
|
---|
[4e143323] | 206 |
|
---|
[3bbd5fe9] | 207 | </sect2>
|
---|
[4e143323] | 208 |
|
---|
[3bbd5fe9] | 209 | </sect1>
|
---|