summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/adt-manual/adt-command.xml91
1 files changed, 50 insertions, 41 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index d459d508a9..e57c15a983 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -1,55 +1,64 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 3
4<chapter id='adt-command'> 4<chapter id='using-the-command-line'>
5 5<title>Using the Command Line</title>
6<title>Yocto Project Kernel Architecture and Use Manual</title>
7
8<section id='command'>
9 <title>Introduction</title>
10 <para> 6 <para>
11 The Yocto Project presents the kernel as a fully patched, history-clean git 7 Recall that earlier we talked about how to use an existing toolchain
12 repository. 8 tarball that had been installed into <filename>/opt/poky</filename>,
13 The git tree represents the selected features, board support, 9 which is outside of the Poky build environment
14 and configurations extensively tested by Yocto Project. 10 (see <xref linkend='using-an-existing-toolchain-tarball'>
15 The Yocto Project kernel allows the end user to leverage community 11 “Using an Existing Toolchain Tarball”)</xref>.
16 best practices to seamlessly manage the development, build and debug cycles. 12 And, that sourcing your architecture-specific environment setup script
13 initializes a suitable development environment.
14 This setup occurs by adding the compiler, QEMU scripts, QEMU binary,
15 a special version of <filename>pkgconfig</filename> and other useful
16 utilities to the <filename>PATH</filename> variable.
17 Variables to assist pkgconfig and autotools are also defined so that,
18 for example, <filename>configure.sh</filename> can find pre-generated
19 test results for tests that need target hardware on which to run.
20 These conditions allow you to easily use the toolchain outside of the
21 Poky build environment on both autotools-based projects and
22 makefile-based projects.
17 </para> 23 </para>
24
25<section id='autotools-based-projects'>
26<title>Autotools-Based Projects</title>
18 <para> 27 <para>
19 This manual describes the Yocto Project kernel by providing information 28 For an autotools-based project you can use the cross-toolchain by just
20 on its history, organization, benefits, and use. 29 passing the appropriate host option to <filename>configure.sh</filename>.
21 The manual consists of two sections: 30 The host option you use is derived from the name of the environment setup
22 <itemizedlist> 31 script in <filename>/opt/poky</filename> resulting from unpacking the
23 <listitem><para>Concepts - Describes concepts behind the kernel. 32 cross-toolchain tarball.
24 You will understand how the kernel is organized and why it is organized in 33 For example, the host option for an ARM-based target that uses the GNU EABI
25 the way it is. You will understand the benefits of the kernel's organization 34 is <filename>armv5te-poky-linux-gnueabi</filename>.
26 and the mechanisms used to work with the kernel and how to apply it in your 35 Note that the name of the script is
27 design process.</para></listitem> 36 <filename>environment-setup-armv5te-poky-linux-gnueabi</filename>.
28 <listitem><para>Using the Kernel - Describes best practices and "how-to" information 37 Thus, the following command works:
29 that lets you put the kernel to practical use. Some examples are "How to Build a 38 <literallayout class='monospaced'>
30 Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel 39 $ configure &dash;&dash;host-armv5te-poky-linux-gnueabi &dash;&dash;with-libtool-sysroot=&lt;sysroot-dir&gt;
31 Modifications."</para></listitem> 40 </literallayout>
32 </itemizedlist>
33 </para> 41 </para>
34 <para> 42 <para>
35 For more information on the kernel, see the following links: 43 This single command updates your project and rebuilds it using the appropriate
36 <itemizedlist> 44 cross-toolchain tools.
37 <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem>
38 <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem>
39 <listitem><para><ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem>
40 </itemizedlist>
41 <para>
42 You can find more information on Yocto Project by visiting the website at
43 <ulink url='http://www.yoctoproject.org'></ulink>.
44 </para>
45 </para> 45 </para>
46</section> 46</section>
47 47
48 48<section id='makefile-based-projects'>
49 49<title>Makefile-Based Projects</title>
50 50 <para>
51 51 For a makefile-based project you use the cross-toolchain by making sure
52 52 the tools are used.
53 You can do this as follows:
54 <literallayout class='monospaced'>
55 CC=arm-poky-linux-gnueabi-gcc
56 LD=arm-poky-linux-gnueabi-ld
57 CFLAGS=”${CFLAGS} &dash;&dash;sysroot=&lt;sysroot-dir&gt;”
58 CXXFLAGS=”${CXXFLAGS} &dash;&dash;sysroot=&lt;sysroot-dir&gt;”
59 </literallayout>
60 </para>
61</section>
53 62
54</chapter> 63</chapter>
55<!-- 64<!--