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