source: BOOK/final-system/common/binutils.xml @ 087231b

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 087231b was 087231b, checked in by Jim Gifford <clfs@…>, 15 years ago

Added: Binutils Branch Update Patch

  • Property mode set to 100644
File size: 11.7 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
8<sect1 id="ch-system-binutils" role="wrap">
9  <?dbhtml filename="binutils.html"?>
10
11  <title>Binutils-&binutils-version;</title>
12
13  <indexterm zone="ch-system-binutils">
14    <primary sortas="a-Binutils">Binutils</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Binutils package contains a linker, an assembler, and other
21    tools for handling object files.</para>
22
23  </sect2>
24
25  <sect2 role="installation">
26    <title>Installation of Binutils</title>
27
28    <para os="b">Verify that the PTYs are working properly inside the build
29    environment. Check that everything is set up correctly by performing a
30    simple test:</para>
31
32<screen os="c" role="nodump"><userinput>expect -c "spawn ls"</userinput></screen>
33
34    <para os="d">This command should give the following output:</para>
35
36<screen os="e"><computeroutput>spawn ls</computeroutput></screen>
37
38    <para os="f">If, instead, it gives a message saying to create more ptys,
39    then the environment is not set up for proper PTY operation. This issue
40    needs to be resolved before running the test suites for Binutils and GCC.</para>
41
42    <para os="p1">The following patch contains a number of updates to the
43    &binutils-version; branch by the Binutils developers:</para>
44
45<screen os="p2"><userinput>patch -Np1 -i ../&binutils-branch_update-patch;</userinput></screen>
46
47    <para os="g">The Binutils documentation recommends building Binutils outside of the
48    source directory in a dedicated build directory:</para>
49
50<screen os="h"><userinput>mkdir -v ../binutils-build
51cd ../binutils-build</userinput></screen>
52
53    <para os="i">Prepare Binutils for compilation:</para>
54
55<screen os="ca"><userinput>CC="gcc -isystem /usr/include" \
56    LDFLAGS="-Wl,-rpath-link,/lib" \
57    ../binutils-&binutils-version;/configure --prefix=/usr \
58    --enable-shared</userinput></screen>
59
60    <para os="j">Compile the package:</para>
61
62<screen os="k"><userinput>make configure-host</userinput></screen>
63
64    <important os="l">
65      <para>During <command>make configure-host</command> you may receive the
66      following error message. It is safe to ignore.</para>
67
68<screen><computeroutput>WARNING: `flex' is missing on your system. You should only
69need it if you modified a `.l' file. You may need the `Flex'
70package in order for those modifications to take effect. You
71can get `Flex' from any GNU archive site.</computeroutput></screen>
72    </important>
73
74<screen os="m"><userinput>make tooldir=/usr</userinput></screen>
75
76    <variablelist os="n">
77      <title>The meaning of the make parameter:</title>
78
79      <varlistentry>
80        <term><parameter>tooldir=/usr</parameter></term>
81        <listitem>
82          <para>Normally, the tooldir (the directory where the executables
83          will ultimately be located) is set to <filename
84          class="directory">$(exec_prefix)/$(target_alias)</filename>. Because this
85          is a custom system, this target-specific directory in <filename
86          class="directory">/usr</filename> is not required.</para>
87        </listitem>
88      </varlistentry>
89    </variablelist>
90
91    <important os="o">
92      <para>The test suite for Binutils is considered critical.
93      Do not skip it under any circumstance.</para>
94    </important>
95
96    <para os="p">Test the results:</para>
97
98<screen os="q"><userinput>make check</userinput></screen>
99
100    <para os="r">Install the package:</para>
101
102<screen os="s"><userinput>make tooldir=/usr install</userinput></screen>
103
104    <para os="t">Install the <filename class="headerfile">libiberty</filename> header
105    file that is needed by some packages:</para>
106
107<screen os="u"><userinput>cp -v ../binutils-&binutils-version;/include/libiberty.h /usr/include</userinput></screen>
108
109  </sect2>
110
111  <sect2 id="contents-binutils" role="content">
112    <title>Contents of Binutils</title>
113
114    <segmentedlist>
115      <segtitle>Installed programs</segtitle>
116      <segtitle>Installed libraries</segtitle>
117
118      <seglistitem>
119        <seg>addr2line, ar, as, c++filt, gprof, ld, nm, objcopy, objdump,
120        ranlib, readelf, size, strings, and strip</seg>
121        <seg>libiberty.a, libbfd.[a,so], and libopcodes.[a,so]</seg>
122      </seglistitem>
123    </segmentedlist>
124
125    <variablelist>
126      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
127      <?dbfo list-presentation="list"?>
128      <?dbhtml list-presentation="table"?>
129
130      <varlistentry id="addr2line">
131        <term><command>addr2line</command></term>
132        <listitem>
133          <para>Translates program addresses to file names and line numbers;
134          given an address and the name of an executable, it uses the debugging
135          information in the executable to determine which source file and line
136          number are associated with the address</para>
137          <indexterm zone="ch-system-binutils addr2line">
138            <primary sortas="b-addr2line">addr2line</primary>
139          </indexterm>
140        </listitem>
141      </varlistentry>
142
143      <varlistentry id="ar">
144        <term><command>ar</command></term>
145        <listitem>
146          <para>Creates, modifies, and extracts from archives</para>
147          <indexterm zone="ch-system-binutils ar">
148            <primary sortas="b-ar">ar</primary>
149          </indexterm>
150        </listitem>
151      </varlistentry>
152
153      <varlistentry id="as">
154        <term><command>as</command></term>
155        <listitem>
156          <para>An assembler that assembles the output of <command>gcc</command>
157          into object files</para>
158          <indexterm zone="ch-system-binutils as">
159            <primary sortas="b-as">as</primary>
160          </indexterm>
161        </listitem>
162      </varlistentry>
163
164      <varlistentry id="c-filt">
165        <term><command>c++filt</command></term>
166        <listitem>
167          <para>Used by the linker to de-mangle C++ and Java symbols and to keep
168          overloaded functions from clashing</para>
169          <indexterm zone="ch-system-binutils c-filt">
170            <primary sortas="b-c++filt">c++filt</primary>
171          </indexterm>
172        </listitem>
173      </varlistentry>
174
175      <varlistentry id="gprof">
176        <term><command>gprof</command></term>
177        <listitem>
178          <para>Displays call graph profile data</para>
179          <indexterm zone="ch-system-binutils gprof">
180            <primary sortas="b-gprof">gprof</primary>
181          </indexterm>
182        </listitem>
183      </varlistentry>
184
185      <varlistentry id="ld">
186        <term><command>ld</command></term>
187        <listitem>
188          <para>A linker that combines a number of object and archive files
189          into a single file, relocating their data and tying up symbol
190          references</para>
191          <indexterm zone="ch-system-binutils ld">
192            <primary sortas="b-ld">ld</primary>
193          </indexterm>
194        </listitem>
195      </varlistentry>
196
197      <varlistentry id="nm">
198        <term><command>nm</command></term>
199        <listitem>
200          <para>Lists the symbols occurring in a given object file</para>
201          <indexterm zone="ch-system-binutils nm">
202            <primary sortas="b-nm">nm</primary>
203          </indexterm>
204        </listitem>
205      </varlistentry>
206
207      <varlistentry id="objcopy">
208        <term><command>objcopy</command></term>
209        <listitem>
210          <para>Translates one type of object file into another</para>
211          <indexterm zone="ch-system-binutils objcopy">
212            <primary sortas="b-objcopy">objcopy</primary>
213          </indexterm>
214        </listitem>
215      </varlistentry>
216
217      <varlistentry id="objdump">
218        <term><command>objdump</command></term>
219        <listitem>
220          <para>Displays information about the given object file, with options
221          controlling the particular information to display; the information
222          shown is useful to programmers who are working on the compilation
223          tools</para>
224          <indexterm zone="ch-system-binutils objdump">
225            <primary sortas="b-objdump">objdump</primary>
226          </indexterm>
227        </listitem>
228      </varlistentry>
229
230      <varlistentry id="ranlib">
231        <term><command>ranlib</command></term>
232        <listitem>
233          <para>Generates an index of the contents of an archive and stores it
234          in the archive; the index lists all of the symbols defined by archive
235          members that are relocatable object files</para>
236          <indexterm zone="ch-system-binutils ranlib">
237            <primary sortas="b-ranlib">ranlib</primary>
238          </indexterm>
239        </listitem>
240      </varlistentry>
241
242      <varlistentry id="readelf">
243        <term><command>readelf</command></term>
244        <listitem>
245          <para>Displays information about ELF type binaries</para>
246          <indexterm zone="ch-system-binutils readelf">
247            <primary sortas="b-readelf">readelf</primary>
248          </indexterm>
249        </listitem>
250      </varlistentry>
251
252      <varlistentry id="size">
253        <term><command>size</command></term>
254        <listitem>
255          <para>Lists the section sizes and the total size for the given
256          object files</para>
257          <indexterm zone="ch-system-binutils size">
258            <primary sortas="b-size">size</primary>
259          </indexterm>
260        </listitem>
261      </varlistentry>
262
263      <varlistentry id="strings">
264        <term><command>strings</command></term>
265        <listitem>
266          <para>Outputs, for each given file, the sequences of printable
267          characters that are of at least the specified length (defaulting to
268          four); for object files, it prints, by default, only the strings from
269          the initializing and loading sections while for other types of files,
270          it scans the entire file</para>
271          <indexterm zone="ch-system-binutils strings">
272            <primary sortas="b-strings">strings</primary>
273          </indexterm>
274        </listitem>
275      </varlistentry>
276
277      <varlistentry id="strip">
278        <term><command>strip</command></term>
279        <listitem>
280          <para>Discards symbols from object files</para>
281          <indexterm zone="ch-system-binutils strip">
282            <primary sortas="b-strip">strip</primary>
283          </indexterm>
284        </listitem>
285      </varlistentry>
286
287      <varlistentry id="libiberty">
288        <term><filename class="libraryfile">libiberty</filename></term>
289        <listitem>
290          <para>Contains routines used by various GNU programs, including
291          <command>getopt</command>, <command>obstack</command>,
292          <command>strerror</command>, <command>strtol</command>, and
293          <command>strtoul</command></para>
294          <indexterm zone="ch-system-binutils libiberty">
295            <primary sortas="c-libiberty">libiberty</primary>
296          </indexterm>
297        </listitem>
298      </varlistentry>
299
300      <varlistentry id="libbfd">
301        <term><filename class="libraryfile">libbfd</filename></term>
302        <listitem>
303          <para>The Binary File Descriptor library</para>
304          <indexterm zone="ch-system-binutils libbfd">
305            <primary sortas="c-libbfd">libbfd</primary>
306          </indexterm>
307        </listitem>
308      </varlistentry>
309
310      <varlistentry id="libopcodes">
311        <term><filename class="libraryfile">libopcodes</filename></term>
312        <listitem>
313          <para>A library for dealing with opcodes&mdash;the <quote>readable
314          text</quote> versions of instructions for the processor;
315          it is used for building utilities like
316          <command>objdump</command>.</para>
317          <indexterm zone="ch-system-binutils libopcodes">
318            <primary sortas="c-libopcodes">libopcodes</primary>
319          </indexterm>
320        </listitem>
321      </varlistentry>
322
323    </variablelist>
324
325  </sect2>
326
327</sect1>
Note: See TracBrowser for help on using the repository browser.