source: clfs-embedded/BOOK/cross-tools/common/binutils.xml @ c747e18

Last change on this file since c747e18 was c747e18, checked in by Joe Ciccone <jciccone@…>, 12 years ago

Updated Binutils to 2.20.1.

  • Property mode set to 100644
File size: 11.8 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-cross-tools-binutils" role="wrap">
9  <?dbhtml filename="binutils.html"?>
10
11  <title>Cross Binutils-&binutils-version;</title>
12
13  <indexterm zone="ch-cross-tools-binutils">
14    <primary sortas="a-Binutils">Binutils</primary>
15    <secondary>cross tools</secondary>
16  </indexterm>
17
18  <sect2 role="package">
19    <title/>
20
21    <para>The Binutils package contains a linker, an assembler, and other
22    tools for handling object files.</para>
23
24  </sect2>
25
26  <sect2 role="installation">
27    <title>Installation of Cross Binutils</title>
28
29    <para os="a">It is important that Binutils be the first package compiled
30    because both uClibc and GCC perform various tests on the available
31    linker and assembler to determine which of their own features to
32    enable.</para>
33
34    <para os="b">The Binutils documentation recommends building Binutils outside of the
35    source directory in a dedicated build directory:</para>
36
37<screen os="c"><userinput>mkdir -v ../binutils-build
38cd ../binutils-build</userinput></screen>
39
40    <para os="d">Prepare Binutils for compilation:</para>
41
42<screen os="e"><userinput>../binutils-&binutils-version;/configure --prefix=${CLFS}/cross-tools \
43   --target=${CLFS_TARGET} --with-sysroot=${CLFS} --disable-nls \
44   --enable-shared --disable-multilib</userinput></screen>
45
46    <variablelist os="f">
47      <title>The meaning of the configure options:</title>
48
49      <varlistentry os="f1">
50        <term><parameter>--prefix=${CLFS}/cross-tools</parameter></term>
51        <listitem>
52          <para>This tells the configure script to prepare to install the
53          package in the <filename class="directory">${CLFS}/cross-tools</filename>
54          directory.</para>
55        </listitem>
56      </varlistentry>
57
58      <varlistentry os="f3">
59        <term><parameter>--target=${CLFS_TARGET}</parameter></term>
60        <listitem>
61          <para>When used with --host, this creates a cross-architecture
62          executable that creates files for ${CLFS_TARGET} but runs on
63          the host system.</para>
64        </listitem>
65      </varlistentry>
66
67      <varlistentry os="f4">
68        <term><parameter>--with-sysroot=${CLFS}</parameter></term>
69        <listitem>
70          <para>This tells configure that ${CLFS} is going to be the root
71          of our system. It will now use the specified sysroot, ${CLFS}, as
72          a prefix of the default search paths.</para>
73        </listitem>
74      </varlistentry>
75
76      <varlistentry os="f5">
77        <term><parameter>--disable-nls</parameter></term>
78        <listitem>
79          <para>This disables internationalization as i18n is not needed for the
80          cross-compile tools.</para>
81        </listitem>
82      </varlistentry>
83
84      <varlistentry os="f6">
85        <term><parameter>--enable-shared</parameter></term>
86        <listitem>
87          <para>Enable the creation of the shared libraries.</para>
88        </listitem>
89      </varlistentry>
90
91      <varlistentry os="f7">
92        <term><parameter>--disable-multilib</parameter></term>
93        <listitem>
94          <para>This option disables the building of a multilib
95          capable binutils.</para>
96        </listitem>
97      </varlistentry>
98
99    </variablelist>
100
101    <para os="g">Compile the package:</para>
102
103<screen os="h"><userinput>make configure-host
104make</userinput></screen>
105
106    <variablelist os="i">
107      <title>The meaning of the make options:</title>
108
109      <varlistentry os="i1">
110        <term><parameter>configure-host</parameter></term>
111        <listitem>
112          <para>This checks the host environment and makes sure all the
113          necessary tools are available to compile Binutils.</para>
114        </listitem>
115      </varlistentry>
116
117    </variablelist>
118
119    <para os="j">Install the package:</para>
120
121<screen os="k"><userinput>make install</userinput></screen>
122
123    <para os="l">Copy the <filename class="headerfile">libiberty.h</filename> file to
124    <filename class="directory">${CLFS}/usr/include</filename> directory:</para>
125
126<screen os="m"><userinput>cp -v ../binutils-&binutils-version;/include/libiberty.h ${CLFS}/usr/include</userinput></screen>
127
128  </sect2>
129
130  <sect2 id="contents-binutils" role="content">
131    <title>Contents of Binutils</title>
132
133    <segmentedlist>
134      <segtitle>Installed programs</segtitle>
135      <segtitle>Installed libraries</segtitle>
136
137      <seglistitem>
138        <seg>addr2line, ar, as, c++filt, gprof, ld, nm, objcopy, objdump,
139        ranlib, readelf, size, strings, and strip</seg>
140        <seg>libiberty.a, libbfd.[a,so], and libopcodes.[a,so]</seg>
141      </seglistitem>
142    </segmentedlist>
143
144    <variablelist>
145      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
146      <?dbfo list-presentation="list"?>
147      <?dbhtml list-presentation="table"?>
148
149      <varlistentry id="addr2line">
150        <term><command>addr2line</command></term>
151        <listitem>
152          <para>Translates program addresses to file names and line numbers;
153          given an address and the name of an executable, it uses the debugging
154          information in the executable to determine which source file and line
155          number are associated with the address</para>
156          <indexterm zone="ch-cross-tools-binutils addr2line">
157            <primary sortas="b-addr2line">addr2line</primary>
158          </indexterm>
159        </listitem>
160      </varlistentry>
161
162      <varlistentry id="ar">
163        <term><command>ar</command></term>
164        <listitem>
165          <para>Creates, modifies, and extracts from archives</para>
166          <indexterm zone="ch-cross-tools-binutils ar">
167            <primary sortas="b-ar">ar</primary>
168          </indexterm>
169        </listitem>
170      </varlistentry>
171
172      <varlistentry id="as">
173        <term><command>as</command></term>
174        <listitem>
175          <para>An assembler that assembles the output of <command>gcc</command>
176          into object files</para>
177          <indexterm zone="ch-cross-tools-binutils as">
178            <primary sortas="b-as">as</primary>
179          </indexterm>
180        </listitem>
181      </varlistentry>
182
183      <varlistentry id="c-filt">
184        <term><command>c++filt</command></term>
185        <listitem>
186          <para>Used by the linker to de-mangle C++ and Java symbols and to keep
187          overloaded functions from clashing</para>
188          <indexterm zone="ch-cross-tools-binutils c-filt">
189            <primary sortas="b-c++filt">c++filt</primary>
190          </indexterm>
191        </listitem>
192      </varlistentry>
193
194      <varlistentry id="gprof">
195        <term><command>gprof</command></term>
196        <listitem>
197          <para>Displays call graph profile data</para>
198          <indexterm zone="ch-cross-tools-binutils gprof">
199            <primary sortas="b-gprof">gprof</primary>
200          </indexterm>
201        </listitem>
202      </varlistentry>
203
204      <varlistentry id="ld">
205        <term><command>ld</command></term>
206        <listitem>
207          <para>A linker that combines a number of object and archive files
208          into a single file, relocating their data and tying up symbol
209          references</para>
210          <indexterm zone="ch-cross-tools-binutils ld">
211            <primary sortas="b-ld">ld</primary>
212          </indexterm>
213        </listitem>
214      </varlistentry>
215
216      <varlistentry id="nm">
217        <term><command>nm</command></term>
218        <listitem>
219          <para>Lists the symbols occurring in a given object file</para>
220          <indexterm zone="ch-cross-tools-binutils nm">
221            <primary sortas="b-nm">nm</primary>
222          </indexterm>
223        </listitem>
224      </varlistentry>
225
226      <varlistentry id="objdump">
227        <term><command>objdump</command></term>
228        <listitem>
229          <para>Displays information about the given object file, with options
230          controlling the particular information to display; the information
231          shown is useful to programmers who are working on the compilation
232          tools</para>
233          <indexterm zone="ch-cross-tools-binutils objdump">
234            <primary sortas="b-objdump">objdump</primary>
235          </indexterm>
236        </listitem>
237      </varlistentry>
238
239      <varlistentry id="ranlib">
240        <term><command>ranlib</command></term>
241        <listitem>
242          <para>Generates an index of the contents of an archive and stores it
243          in the archive; the index lists all of the symbols defined by archive
244          members that are relocatable object files</para>
245          <indexterm zone="ch-cross-tools-binutils ranlib">
246            <primary sortas="b-ranlib">ranlib</primary>
247          </indexterm>
248        </listitem>
249      </varlistentry>
250
251      <varlistentry id="readelf">
252        <term><command>readelf</command></term>
253        <listitem>
254          <para>Displays information about ELF type binaries</para>
255          <indexterm zone="ch-cross-tools-binutils readelf">
256            <primary sortas="b-readelf">readelf</primary>
257          </indexterm>
258        </listitem>
259      </varlistentry>
260
261      <varlistentry id="size">
262        <term><command>size</command></term>
263        <listitem>
264          <para>Lists the section sizes and the total size for the given
265          object files</para>
266          <indexterm zone="ch-cross-tools-binutils size">
267            <primary sortas="b-size">size</primary>
268          </indexterm>
269        </listitem>
270      </varlistentry>
271
272      <varlistentry id="strings">
273        <term><command>strings</command></term>
274        <listitem>
275          <para>Outputs, for each given file, the sequences of printable
276          characters that are of at least the specified length (defaulting to
277          four); for object files, it prints, by default, only the strings from
278          the initializing and loading sections while for other types of files,
279          it scans the entire file</para>
280          <indexterm zone="ch-cross-tools-binutils strings">
281            <primary sortas="b-strings">strings</primary>
282          </indexterm>
283        </listitem>
284      </varlistentry>
285
286      <varlistentry id="strip">
287        <term><command>strip</command></term>
288        <listitem>
289          <para>Discards symbols from object files</para>
290          <indexterm zone="ch-cross-tools-binutils strip">
291            <primary sortas="b-strip">strip</primary>
292          </indexterm>
293        </listitem>
294      </varlistentry>
295
296      <varlistentry id="libiberty">
297        <term><filename class="libraryfile">libiberty</filename></term>
298        <listitem>
299          <para>Contains routines used by various GNU programs, including
300          <command>getopt</command>, <command>obstack</command>,
301          <command>strerror</command>, <command>strtol</command>, and
302          <command>strtoul</command></para>
303          <indexterm zone="ch-cross-tools-binutils libiberty">
304            <primary sortas="c-libiberty">libiberty</primary>
305          </indexterm>
306        </listitem>
307      </varlistentry>
308
309      <varlistentry id="libbfd">
310        <term><filename class="libraryfile">libbfd</filename></term>
311        <listitem>
312          <para>The Binary File Descriptor library</para>
313          <indexterm zone="ch-cross-tools-binutils libbfd">
314            <primary sortas="c-libbfd">libbfd</primary>
315          </indexterm>
316        </listitem>
317      </varlistentry>
318
319      <varlistentry id="libopcodes">
320        <term><filename class="libraryfile">libopcodes</filename></term>
321        <listitem>
322          <para>A library for dealing with opcodes&mdash;the <quote>readable
323          text</quote> versions of instructions for the processor;
324          it is used for building utilities like
325          <command>objdump</command>.</para>
326          <indexterm zone="ch-cross-tools-binutils libopcodes">
327            <primary sortas="c-libopcodes">libopcodes</primary>
328          </indexterm>
329        </listitem>
330      </varlistentry>
331
332    </variablelist>
333
334  </sect2>
335
336</sect1>
Note: See TracBrowser for help on using the repository browser.