diff options
Diffstat (limited to 'documentation/profile-manual/profile-manual-intro.xml')
-rw-r--r-- | documentation/profile-manual/profile-manual-intro.xml | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/documentation/profile-manual/profile-manual-intro.xml b/documentation/profile-manual/profile-manual-intro.xml new file mode 100644 index 0000000000..dca24602ed --- /dev/null +++ b/documentation/profile-manual/profile-manual-intro.xml | |||
@@ -0,0 +1,190 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
4 | |||
5 | <chapter id='dev-manual-intro'> | ||
6 | |||
7 | <title>The Yocto Project Development Manual</title> | ||
8 | <section id='intro'> | ||
9 | <title>Introduction</title> | ||
10 | |||
11 | <para> | ||
12 | Welcome to the Yocto Project Development Manual! | ||
13 | This manual gives you an idea of how to use the Yocto Project to develop embedded Linux | ||
14 | images and user-space applications to run on targeted devices. | ||
15 | Reading this manual gives you an overview of image, kernel, and user-space application development | ||
16 | using the Yocto Project. | ||
17 | Because much of the information in this manual is general, it contains many references to other | ||
18 | sources where you can find more detail. | ||
19 | For example, detailed information on Git, repositories and open source in general | ||
20 | can be found in many places. | ||
21 | Another example is how to get set up to use the Yocto Project, which our Yocto Project | ||
22 | Quick Start covers. | ||
23 | </para> | ||
24 | |||
25 | <para> | ||
26 | The Yocto Project Development Manual, however, does provide detailed examples | ||
27 | on how to change the kernel source code, reconfigure the kernel, and develop | ||
28 | an application using the popular <trademark class='trade'>Eclipse</trademark> IDE. | ||
29 | </para> | ||
30 | </section> | ||
31 | |||
32 | <section id='what-this-manual-provides'> | ||
33 | <title>What this Manual Provides</title> | ||
34 | |||
35 | <para> | ||
36 | The following list describes what you can get from this guide: | ||
37 | <itemizedlist> | ||
38 | <listitem><para>Information that lets you get set | ||
39 | up to develop using the Yocto Project.</para></listitem> | ||
40 | <listitem><para>Information to help developers who are new to the open source environment | ||
41 | and to the distributed revision control system Git, which the Yocto Project | ||
42 | uses.</para></listitem> | ||
43 | <listitem><para>An understanding of common end-to-end development models and tasks.</para></listitem> | ||
44 | <listitem><para>Development case overviews for both system development and user-space | ||
45 | applications.</para></listitem> | ||
46 | <listitem><para>An overview and understanding of the emulation environment used with | ||
47 | the Yocto Project - the Quick EMUlator (QEMU).</para></listitem> | ||
48 | <listitem><para>An understanding of basic kernel architecture and concepts.</para></listitem> | ||
49 | <listitem><para>Many references to other sources of related information.</para></listitem> | ||
50 | </itemizedlist> | ||
51 | </para> | ||
52 | </section> | ||
53 | |||
54 | <section id='what-this-manual-does-not-provide'> | ||
55 | <title>What this Manual Does Not Provide</title> | ||
56 | |||
57 | <para> | ||
58 | This manual will not give you the following: | ||
59 | <itemizedlist> | ||
60 | <listitem><para>Step-by-step instructions if those instructions exist in other Yocto | ||
61 | Project documentation. | ||
62 | For example, the Yocto Project Application Developer's Guide contains detailed | ||
63 | instruction on how to run the | ||
64 | <ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>, | ||
65 | which is used to set up a cross-development environment.</para></listitem> | ||
66 | <listitem><para>Reference material. | ||
67 | This type of material resides in an appropriate reference manual. | ||
68 | For example, system variables are documented in the | ||
69 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.</para></listitem> | ||
70 | <listitem><para>Detailed public information that is not specific to the Yocto Project. | ||
71 | For example, exhaustive information on how to use Git is covered better through the | ||
72 | Internet than in this manual.</para></listitem> | ||
73 | </itemizedlist> | ||
74 | </para> | ||
75 | </section> | ||
76 | |||
77 | <section id='other-information'> | ||
78 | <title>Other Information</title> | ||
79 | |||
80 | <para> | ||
81 | Because this manual presents overview information for many different topics, you will | ||
82 | need to supplement it with other information. | ||
83 | The following list presents other sources of information you might find helpful: | ||
84 | <itemizedlist> | ||
85 | <listitem><para><emphasis>The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: | ||
86 | </emphasis> The home page for the Yocto Project provides lots of information on the project | ||
87 | as well as links to software and documentation.</para></listitem> | ||
88 | <listitem><para><emphasis> | ||
89 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started | ||
90 | with the Yocto Project quickly and start building an image.</para></listitem> | ||
91 | <listitem><para><emphasis> | ||
92 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference | ||
93 | guide to the OpenEmbedded build system known as "Poky." | ||
94 | The manual also contains a reference chapter on Board Support Package (BSP) | ||
95 | layout.</para></listitem> | ||
96 | <listitem><para><emphasis> | ||
97 | <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis> | ||
98 | This guide provides information that lets you get going with the Application | ||
99 | Development Toolkit (ADT) and stand-alone cross-development toolchains to | ||
100 | develop projects using the Yocto Project.</para></listitem> | ||
101 | <listitem><para><emphasis> | ||
102 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> | ||
103 | This guide defines the structure for BSP components. | ||
104 | Having a commonly understood structure encourages standardization.</para></listitem> | ||
105 | <listitem><para><emphasis> | ||
106 | <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> | ||
107 | This manual describes the architecture of the Yocto Project kernel and provides | ||
108 | some work flow examples.</para></listitem> | ||
109 | <listitem><para><emphasis> | ||
110 | <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> | ||
111 | Eclipse IDE Yocto Plug-in</ulink>:</emphasis> A step-by-step instructional video that | ||
112 | demonstrates how an application developer uses Yocto Plug-in features within | ||
113 | the Eclipse IDE.</para></listitem> | ||
114 | <listitem><para><emphasis> | ||
115 | <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis> | ||
116 | A list of commonly asked questions and their answers.</para></listitem> | ||
117 | <listitem><para><emphasis> | ||
118 | <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-&DISTRO;-release-notes-poky-&POKYVERSION;'> | ||
119 | Release Notes</ulink>:</emphasis> Features, updates and known issues for the current | ||
120 | release of the Yocto Project.</para></listitem> | ||
121 | <listitem><para><emphasis> | ||
122 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'> | ||
123 | Hob</ulink>:</emphasis> A graphical user interface for BitBake. | ||
124 | Hob's primary goal is to enable a user to perform common tasks more easily.</para></listitem> | ||
125 | <listitem><para><emphasis> | ||
126 | <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'> | ||
127 | Build Appliance</ulink>:</emphasis> A bootable custom embedded Linux image you can | ||
128 | either build using a non-Linux development system (VMware applications) or download | ||
129 | from the Yocto Project website. | ||
130 | See the <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance-manual'>Build Appliance</ulink> | ||
131 | page for more information.</para></listitem> | ||
132 | <listitem><para><emphasis> | ||
133 | <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis> | ||
134 | The bug tracking application the Yocto Project uses. | ||
135 | If you find problems with the Yocto Project, you should report them using this | ||
136 | application.</para></listitem> | ||
137 | <listitem><para><emphasis> | ||
138 | Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing | ||
139 | lists, click on the following URLs and follow the instructions: | ||
140 | <itemizedlist> | ||
141 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a | ||
142 | Yocto Project Discussions mailing list.</para></listitem> | ||
143 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a | ||
144 | Yocto Project Discussions mailing list about the Poky build system.</para></listitem> | ||
145 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> | ||
146 | for a mailing list to receive official Yocto Project announcements for developments and | ||
147 | as well as Yocto Project milestones.</para></listitem> | ||
148 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a | ||
149 | listing of all public mailing lists on <filename>lists.yoctoproject.org</filename>. | ||
150 | </para></listitem> | ||
151 | </itemizedlist></para></listitem> | ||
152 | <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis> | ||
153 | Two IRC channels on freenode are available | ||
154 | for Yocto Project and Poky discussions: <filename>#yocto</filename> and | ||
155 | <filename>#poky</filename>, respectively.</para></listitem> | ||
156 | <listitem><para><emphasis> | ||
157 | <ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis> | ||
158 | The company that initially developed the Poky project, which is the basis | ||
159 | for the OpenEmbedded build system used by the Yocto Project. | ||
160 | OpenedHand was acquired by Intel Corporation in 2008.</para></listitem> | ||
161 | <listitem><para><emphasis> | ||
162 | <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> | ||
163 | A multinational semiconductor chip manufacturer company whose Software and | ||
164 | Services Group created and supports the Yocto Project. | ||
165 | Intel acquired OpenedHand in 2008.</para></listitem> | ||
166 | <listitem><para><emphasis> | ||
167 | <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> | ||
168 | The build system used by the Yocto Project. | ||
169 | This project is the upstream, generic, embedded distribution from which the Yocto | ||
170 | Project derives its build system (Poky) from and to which it contributes.</para></listitem> | ||
171 | <listitem><para><emphasis> | ||
172 | <ulink url='http://developer.berlios.de/projects/bitbake/'> | ||
173 | BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system | ||
174 | to process project metadata.</para></listitem> | ||
175 | <listitem><para><emphasis> | ||
176 | BitBake User Manual:</emphasis> | ||
177 | A comprehensive guide to the BitBake tool. | ||
178 | If you want information on BitBake, see the user manual inculded in the | ||
179 | <filename>bitbake/doc/manual</filename> directory of the | ||
180 | <link linkend='source-directory'>Source Directory</link>.</para></listitem> | ||
181 | <listitem><para><emphasis> | ||
182 | <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>: | ||
183 | </emphasis> An open-source machine emulator and virtualizer.</para></listitem> | ||
184 | </itemizedlist> | ||
185 | </para> | ||
186 | </section> | ||
187 | </chapter> | ||
188 | <!-- | ||
189 | vim: expandtab tw=80 ts=4 | ||
190 | --> | ||