summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-start.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-08-16 09:17:55 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-08-23 18:46:36 -0700
commit1e789e60b5bffc2947e421129fc2ad8ea543874d (patch)
treec3f1a683f2c6f5d7f92ae3fc85e0f588e29948de /documentation/dev-manual/dev-manual-start.xml
parent0a2e82c0070c0143b73ac45731d6e79d6c8ce066 (diff)
downloadpoky-1e789e60b5bffc2947e421129fc2ad8ea543874d.tar.gz
documentation/dev-manual: Incorporated Joshua Lock's review comments.
(From yocto-docs rev: d4bf6343d7575ff96030242e2025570db52b515b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.xml')
-rw-r--r--documentation/dev-manual/dev-manual-start.xml30
1 files changed, 17 insertions, 13 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 48f98b50b5..07caed3132 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -24,15 +24,16 @@
24 24
25 <para> 25 <para>
26 The Yocto Project is an open-source collaboration project focused on embedded Linux development. 26 The Yocto Project is an open-source collaboration project focused on embedded Linux development.
27 The project provides a recent Linux kernel along with a set of system commands, libraries, 27 The project currently provides a build system and various ancillary tools suitable for the
28 and system components suitable for the embedded developer. 28 embedded developer.
29 The Yocto Project also features the Sato reference User Interface should you be dealing with 29 The Yocto Project also features the Sato reference User Interface, which is optimized for
30 devices with restricted screens. 30 stylus driven, low-resolution screens.
31 </para> 31 </para>
32 32
33 <para> 33 <para>
34 You can use the Yocto Project, which uses the BitBake build tool, to develop complete Linux 34 You can use the Yocto Project, which uses the BitBake build tool, to develop complete Linux
35 images and user-space applications for architectures based on ARM, MIPS, PowerPC, x86 and x86-64. 35 images and associated user-space applications for architectures based on ARM, MIPS, PowerPC,
36 x86 and x86-64.
36 You can perform target-level testing and debugging as well as test in a hardware emulated environment. 37 You can perform target-level testing and debugging as well as test in a hardware emulated environment.
37 And, if you are an Eclipse user, you can install an Eclipse Yocto Plug-in to allow you to 38 And, if you are an Eclipse user, you can install an Eclipse Yocto Plug-in to allow you to
38 develop within that familiar environment. 39 develop within that familiar environment.
@@ -45,16 +46,18 @@
45 <para> 46 <para>
46 Here is what you need to get set up to use the Yocto Project: 47 Here is what you need to get set up to use the Yocto Project:
47 <itemizedlist> 48 <itemizedlist>
48 <listitem><para><emphasis>Host System:</emphasis> You need a recent release of Fedora, 49 <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current
49 OpenSUSE, Debian, or Ubuntu. 50 Linux-based host system.
50 You should have a reasonably current Linux-based host system. 51 You will have the best results with a recent release of Fedora,
52 OpenSUSE, or Ubuntu as these releases are frequently tested and officially supported
53 host systems.
51 You should also have about 100 gigabytes of free disk space for building images. 54 You should also have about 100 gigabytes of free disk space for building images.
52 </para></listitem> 55 </para></listitem>
53 <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages 56 <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages
54 exist on your development system. 57 exist on your development system (e.g. Python 2.6 or 2.7).
55 See the <ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html#packages'> 58 See <ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html#packages'>
56 The Packages</ulink> section in the Yocto Project Quick start for the exact package 59 The Packages</ulink> section in the Yocto Project Quick start for the exact package
57 requirements.</para></listitem> 60 requirements and the installation commands for the supported distributions.</para></listitem>
58 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> 61 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
59 You need a release of the Yocto Project. 62 You need a release of the Yocto Project.
60 You can get set up with local Yocto Project files one of two ways depending on whether you 63 You can get set up with local Yocto Project files one of two ways depending on whether you
@@ -210,7 +213,8 @@
210 wiki page</ulink> referenced earlier covers how to 213 wiki page</ulink> referenced earlier covers how to
211 set up the <filename>meta-intel</filename> Git repository.</para></listitem> 214 set up the <filename>meta-intel</filename> Git repository.</para></listitem>
212 </itemizedlist></para></listitem> 215 </itemizedlist></para></listitem>
213 <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing using the 216 <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing
217 applications using the
214 Eclipse Integrated Development Environment (IDE) you will need this plug-in. 218 Eclipse Integrated Development Environment (IDE) you will need this plug-in.
215 See the 219 See the
216 <ulink url='http://www.yoctoproject.org/docs/adt-manual/adt-manual.html#setting-up-the-eclipse-ide'> 220 <ulink url='http://www.yoctoproject.org/docs/adt-manual/adt-manual.html#setting-up-the-eclipse-ide'>
@@ -237,7 +241,7 @@
237 previous section.</para></listitem> 241 previous section.</para></listitem>
238 <listitem><para>Initialize the build environment by sourcing a build environment 242 <listitem><para>Initialize the build environment by sourcing a build environment
239 script.</para></listitem> 243 script.</para></listitem>
240 <listitem><para>Make sure the <filename>conf/local.conf</filename> configuration file is set 244 <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file is set
241 up how you want it. 245 up how you want it.
242 This file defines the target machine architecture and and other build options.</para></listitem> 246 This file defines the target machine architecture and and other build options.</para></listitem>
243 <listitem><para>Build the image using the BitBake command. 247 <listitem><para>Build the image using the BitBake command.