Typo
[linux_from_scratch.git] / chapter05 / binutils-pass1.xml
blobca8e5b8f771fc1742e10c977b2d0c6c3b849de32
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 ]>
8 <sect1 id="ch-tools-binutils-pass1" role="wrap">
9   <?dbhtml filename="binutils-pass1.html"?>
11   <sect1info condition="script">
12     <productname>binutils</productname>
13     <productnumber>&binutils-version;</productnumber>
14     <address>&binutils-url;</address>
15   </sect1info>
17   <title>Binutils-&binutils-version; - Pass 1</title>
19   <indexterm zone="ch-tools-binutils-pass1">
20     <primary sortas="a-Binutils">Binutils</primary>
21     <secondary>tools, pass 1</secondary>
22   </indexterm>
24   <sect2 role="package">
25     <title/>
27     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
28     href="../chapter06/binutils.xml"
29     xpointer="xpointer(/sect1/sect2[1]/para[1])"/>
31     <segmentedlist>
32       <segtitle>&buildtime;</segtitle>
33       <segtitle>&diskspace;</segtitle>
35       <seglistitem>
36         <seg>&binutils-ch5p1-sbu;</seg>
37         <seg>&binutils-ch5p1-du;</seg>
38       </seglistitem>
39     </segmentedlist>
41   </sect2>
43   <sect2 role="installation">
44     <title>Installation of Cross Binutils</title>
46     <note><para>Go back and re-read the notes in the previous section. 
47     Understanding the notes labeled important will save you a lot
48     of problems later.</para></note>
50     <para>It is important that Binutils be the first package compiled
51     because both Glibc and GCC perform various tests on the available
52     linker and assembler to determine which of their own features to
53     enable.</para>
55     <para>The Binutils documentation recommends building Binutils outside of the
56     source directory in a dedicated build directory:</para>
58 <screen><userinput remap="pre">mkdir -v ../binutils-build
59 cd ../binutils-build</userinput></screen>
61     <note>
62       <para>In order for the SBU values listed in the rest of the book
63       to be of any use, measure the time it takes to build this package from
64       the configuration, up to and including the first install. To achieve
65       this easily, wrap the three commands in a <command>time</command>
66       command like this: <userinput>time { ./configure ... &amp;&amp; make
67       &amp;&amp; make install; }</userinput>.</para>
68     </note>
70     <note><para>The approximate build SBU values and required disk space
71     in Chapter 5 does not include test suite data.</para></note>
73     <para>Now prepare Binutils for compilation:</para>
75 <screen><userinput remap="configure">../binutils-&binutils-version;/configure \
76     --target=$LFS_TGT --prefix=/tools \
77     --disable-nls --disable-werror</userinput></screen>
79     <variablelist>
80       <title>The meaning of the configure options:</title>
82       <varlistentry>
83         <term><envar>--target=$LFS_TGT</envar></term>
84         <listitem>
85           <para>Because the machine description in the <envar>LFS_TGT</envar>
86           variable is slightly different than the value returned by the
87           <command>config.guess</command> script, this switch will tell the
88           <command>configure</command> script to adjust Binutil's build system
89           for building a cross linker.  </para>
90         </listitem>
91       </varlistentry>
93       <varlistentry>
94         <term><parameter>--prefix=/tools</parameter></term>
95         <listitem>
96           <para>This tells the configure script to prepare to install the
97           Binutils programs in the <filename class="directory">/tools</filename>
98           directory.</para>
99         </listitem>
100       </varlistentry>
102       <varlistentry>
103         <term><parameter>--disable-nls</parameter></term>
104         <listitem>
105           <para>This disables internationalization as i18n is not needed for the
106           temporary tools.</para>
107         </listitem>
108       </varlistentry>
110       <varlistentry>
111         <term><parameter>--disable-werror</parameter></term>
112         <listitem>
113           <para>This prevents the build from stopping in the event that there
114           are warnings from the host's compiler.</para>
115         </listitem>
116       </varlistentry>
118     </variablelist>
120     <para>Continue with compiling the package:</para>
122 <screen><userinput remap="make">make</userinput></screen>
124     <para>Compilation is now complete. Ordinarily we would now run the
125     test suite, but at this early stage the test suite framework (Tcl,
126     Expect, and DejaGNU) is not yet in place. The benefits of running the
127     tests at this point are minimal since the programs from this
128     first pass will soon be replaced by those from the second.</para>
130     <para>If building on x86_64, create a symlink to ensure the sanity of
131     the toolchain:</para>
133 <screen><userinput remap="install">case $(uname -m) in
134   x86_64) mkdir -v /tools/lib &amp;&amp; ln -sv lib /tools/lib64 ;;
135 esac</userinput></screen>
137     <para>Install the package:</para>
139 <screen><userinput remap="install">make install</userinput></screen>
141   </sect2>
143   <sect2 role="content">
144     <title/>
146     <para>Details on this package are located in
147     <xref linkend="contents-binutils" role="."/></para>
149   </sect2>
151 </sect1>