source: general/prog/gc.xml@ 410d9d0

10.0 10.1 11.0 11.1 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 410d9d0 was 410d9d0, checked in by Douglas R. Reno <renodr@…>, 5 years ago

Tags
update check testing information

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19057 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 6.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gc-download-http "http://www.hboehm.info/gc/gc_source/gc-&gc-version;.tar.gz">
8 <!ENTITY gc-download-ftp " ">
9 <!ENTITY gc-md5sum "bf46ccbdaccfa3186c2ab87191c8855a">
10 <!ENTITY gc-size "1.1 MB">
11 <!ENTITY gc-buildsize "13 MB (with tests)">
12 <!ENTITY gc-time "0.2 SBU (with tests)">
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
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
46 &lfs81_checked;
47
48 <bridgehead renderas="sect3">Package Information</bridgehead>
49 <itemizedlist spacing="compact">
50 <listitem>
51 <para>
52 Download (HTTP): <ulink url="&gc-download-http;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download (FTP): <ulink url="&gc-download-ftp;"/>
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download MD5 sum: &gc-md5sum;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Download size: &gc-size;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated disk space required: &gc-buildsize;
73 </para>
74 </listitem>
75 <listitem>
76 <para>
77 Estimated build time: &gc-time;
78 </para>
79 </listitem>
80 </itemizedlist>
81
82 <bridgehead renderas="sect4">Required</bridgehead>
83 <para role="required">
84 <xref linkend="libatomic_ops"/>
85 </para>
86<!-- (Gc contains a copy of
87 Libatomic_ops-&gc-version; which it will compile and statically link if
88 configure doesn't find Libatomic_ops installed on your system)
89 </para>
90-->
91
92 <para condition="html" role="usernotes">
93 User Notes: <ulink url="&blfs-wiki;/gc"/>
94 </para>
95 </sect2>
96
97 <sect2 role="installation">
98 <title>Installation of GC</title>
99
100 <para>
101 Install <application>GC</application> by running the following commands:
102 </para>
103
104<screen><userinput>sed -i 's#pkgdata#doc#' doc/doc.am &amp;&amp;
105autoreconf -fi &amp;&amp;
106./configure --prefix=/usr \
107 --enable-cplusplus \
108 --disable-static \
109 --docdir=/usr/share/doc/gc-&gc-version; &amp;&amp;
110make</userinput></screen>
111
112 <para>
113 To test the results, issue: <command>make check</command>.
114 </para>
115
116 <para>
117 Now, as the <systemitem class="username">root</systemitem> user:
118 </para>
119
120<screen role="root"><userinput>make install &amp;&amp;
121install -v -m644 doc/gc.man /usr/share/man/man3/gc_malloc.3 &amp;&amp;
122ln -sfv gc_malloc.3 /usr/share/man/man3/gc.3</userinput></screen>
123 </sect2>
124
125 <sect2 role="commands">
126 <title>Command Explanations</title>
127
128 <para>
129 <command>sed -i 's#pkgdata#doc#' doc/doc.am</command> and
130 <parameter>--docdir=/usr/share/doc/gc-&gc-version;</parameter>:
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.
139 </para>
140
141 <para>
142 <parameter>--enable-cplusplus</parameter>: This parameter enables the
143 building and installing of the C++ library along with the standard
144 C library.
145 </para>
146
147 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
148 href="../../xincludes/static-libraries.xml"/>
149
150 </sect2>
151
152 <sect2 role="content">
153 <title>Contents</title>
154
155 <segmentedlist>
156 <segtitle>Installed Programs</segtitle>
157 <segtitle>Installed Libraries</segtitle>
158 <segtitle>Installed Directories</segtitle>
159
160 <seglistitem>
161 <seg>
162 None
163 </seg>
164 <seg>
165 libcord.so, libgc.so and
166 libgccpp.so
167 </seg>
168 <seg>
169 /usr/include/gc and
170 /usr/share/doc/gc-&gc-version;
171 </seg>
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">
181 <term><filename class="libraryfile">libgc.so</filename></term>
182 <listitem>
183 <para>
184 contains a C interface to the conservative garbage collector,
185 primarily designed to replace the C malloc function.
186 </para>
187 <indexterm zone="gc libgc">
188 <primary sortas="c-libgc">libgc.so</primary>
189 </indexterm>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry id="libgccpp">
194 <term><filename class="libraryfile">libgccpp.so</filename></term>
195 <listitem>
196 <para>
197 contains a C++ interface to the conservative garbage collector.
198 </para>
199 <indexterm zone="gc libgccpp">
200 <primary sortas="c-libgccpp">libgccpp.so</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 </variablelist>
206
207 </sect2>
208
209</sect1>
Note: See TracBrowser for help on using the repository browser.