aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual/adt-command.xml
blob: 43bd08b74fb39fd2e015390c184942adec0f72ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >

<chapter id='using-the-command-line'>
<title>Using the Command Line</title>

    <para>
        Recall that earlier the manual discussed how to use an existing toolchain 
        tarball that had been installed into <filename>/opt/poky</filename>, 
        which is outside of the Yocto Project build tree 
        (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using an Existing 
        Toolchain Tarball)</link>".  
        And, that sourcing your architecture-specific environment setup script 
        initializes a suitable cross-toolchain development environment.  
        During the setup, locations for the compiler, QEMU scripts, QEMU binary, 
        a special version of <filename>pkgconfig</filename> and other useful 
        utilities are added to the <filename>PATH</filename> variable.
        Variables to assist <filename>pkgconfig</filename> and <filename>autotools</filename> 
        are also defined so that, 
        for example, <filename>configure.sh</filename> can find pre-generated 
        test results for tests that need target hardware on which to run.  
        These conditions allow you to easily use the toolchain outside of the 
        Yocto Project build environment on both autotools-based projects and 
        Makefile-based projects.
    </para>

<section id='autotools-based-projects'>
<title>Autotools-Based Projects</title>

    <para>
        For an Autotools-based project, you can use the cross-toolchain by just 
        passing the appropriate host option to <filename>configure.sh</filename>.
        The host option you use is derived from the name of the environment setup 
        script in <filename>/opt/poky</filename> resulting from unpacking the 
        cross-toolchain tarball.
        For example, the host option for an ARM-based target that uses the GNU EABI 
        is <filename>armv5te-poky-linux-gnueabi</filename>.
        Note that the name of the script is 
        <filename>environment-setup-armv5te-poky-linux-gnueabi</filename>.
        Thus, the following command works:
        <literallayout class='monospaced'>
     $ configure --host=armv5te-poky-linux-gnueabi \
        --with-libtool-sysroot=&lt;sysroot-dir&gt;
        </literallayout>
    </para>
    <para>
        This single command updates your project and rebuilds it using the appropriate 
        cross-toolchain tools.
    </para>
    <note>
        If <filename>configure</filename> script results in problems recognizing the 
        <filename>--with-libtool-sysroot=&lt;sysroot-dir&gt;</filename> option, 
        regenerate the script to enable the support by doing the following and then 
        re-running the script:
        <literallayout class='monospaced'>
     $ libtoolize --automake
     $ aclocal -I ${OECORE_NATIVE_SYSROOT}/usr/share/aclocal \
        [-I &lt;dir_containing_your_project-specific_m4_macros&gt;]
     $ autoconf
     $ autoheader
     $ automake -a
        </literallayout>
    </note>       
</section>

<section id='makefile-based-projects'>
<title>Makefile-Based Projects</title>

    <para>
        For a Makefile-based project, you use the cross-toolchain by making sure 
        the tools are used.  
        You can do this as follows:
        <literallayout class='monospaced'>
     CC=arm-poky-linux-gnueabi-gcc
     LD=arm-poky-linux-gnueabi-ld
     CFLAGS=”${CFLAGS} --sysroot=&lt;sysroot-dir&gt;”
     CXXFLAGS=”${CXXFLAGS} --sysroot=&lt;sysroot-dir&gt;</literallayout>
    </para>
</section>

</chapter>
<!--
vim: expandtab tw=80 ts=4
-->