diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 141 | ||||
-rw-r--r-- | documentation/ref-manual/introduction.xml | 139 | ||||
-rw-r--r-- | documentation/ref-manual/resources.xml | 224 |
3 files changed, 274 insertions, 230 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 49148abead..020f9373e6 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml | |||
@@ -109,144 +109,13 @@ | |||
109 | <title>Other Information</title> | 109 | <title>Other Information</title> |
110 | 110 | ||
111 | <para> | 111 | <para> |
112 | Because this manual presents overview information for many different | 112 | Because this manual presents information for many different |
113 | topics, supplemental information is recommended for full | 113 | topics, supplemental information is recommended for full |
114 | comprehension. | 114 | comprehension. |
115 | The following list presents other sources of information you might find helpful: | 115 | See the |
116 | <itemizedlist> | 116 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>" |
117 | <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: | 117 | section in the Yocto Project Reference Manual for helpful |
118 | </emphasis> The home page for the Yocto Project provides lots of information on the project | 118 | sources. |
119 | as well as links to software and documentation. | ||
120 | </para></listitem> | ||
121 | <listitem><para><emphasis> | ||
122 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> | ||
123 | This short document lets you get started | ||
124 | with the Yocto Project and quickly begin building an image. | ||
125 | </para></listitem> | ||
126 | <listitem><para><emphasis> | ||
127 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> | ||
128 | This manual is a reference | ||
129 | guide to the OpenEmbedded build system, which is based on BitBake. | ||
130 | The build system is sometimes referred to as "Poky". | ||
131 | </para></listitem> | ||
132 | <listitem><para><emphasis> | ||
133 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>:</emphasis> | ||
134 | This guide provides information that lets you get going | ||
135 | with the standard or extensible SDK. | ||
136 | An SDK, with its cross-development toolchains, allows you | ||
137 | to develop projects inside or outside of the Yocto Project | ||
138 | environment. | ||
139 | </para></listitem> | ||
140 | <listitem><para><emphasis> | ||
141 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> | ||
142 | This guide defines the structure for BSP components. | ||
143 | Having a commonly understood structure encourages standardization. | ||
144 | </para></listitem> | ||
145 | <listitem><para><emphasis> | ||
146 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis> | ||
147 | This manual describes how to work with Linux Yocto kernels as well as provides a bit | ||
148 | of conceptual information on the construction of the Yocto Linux kernel tree. | ||
149 | </para></listitem> | ||
150 | <listitem><para><emphasis> | ||
151 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis> | ||
152 | This manual presents a set of common and generally useful tracing and | ||
153 | profiling schemes along with their applications (as appropriate) to each tool. | ||
154 | </para></listitem> | ||
155 | <listitem><para><emphasis> | ||
156 | <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:</emphasis> | ||
157 | This manual introduces and describes how to set up and use | ||
158 | Toaster, which is a web interface to the Yocto Project's | ||
159 | <link linkend='build-system-term'>OpenEmbedded Build System</link>. | ||
160 | </para></listitem> | ||
161 | <!-- | ||
162 | <listitem><para><emphasis> | ||
163 | <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> | ||
164 | Eclipse IDE Yocto Plug-in</ulink>:</emphasis> | ||
165 | A step-by-step instructional video that | ||
166 | demonstrates how an application developer uses Yocto Plug-in features within | ||
167 | the Eclipse IDE. | ||
168 | </para></listitem> | ||
169 | --> | ||
170 | <listitem><para><emphasis> | ||
171 | <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-appendix-latest-yp-eclipse-plug-in'>Eclipse IDE Yocto Plug-in</ulink>:</emphasis> | ||
172 | Instructions that demonstrate how an application developer | ||
173 | uses the Eclipse Yocto Project Plug-in feature within | ||
174 | the Eclipse IDE. | ||
175 | </para></listitem> | ||
176 | <listitem><para><emphasis> | ||
177 | <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis> | ||
178 | A list of commonly asked questions and their answers. | ||
179 | </para></listitem> | ||
180 | <listitem><para><emphasis> | ||
181 | <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis> | ||
182 | Features, updates and known issues for the current | ||
183 | release of the Yocto Project. | ||
184 | </para></listitem> | ||
185 | <listitem><para><emphasis> | ||
186 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>:</emphasis> | ||
187 | An Application Programming Interface (API) and web-based | ||
188 | interface to the OpenEmbedded build system, which uses | ||
189 | BitBake, that reports build information. | ||
190 | </para></listitem> | ||
191 | <listitem><para><emphasis> | ||
192 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:</emphasis> | ||
193 | A virtual machine that | ||
194 | enables you to build and boot a custom embedded Linux image | ||
195 | with the Yocto Project using a non-Linux development system. | ||
196 | </para></listitem> | ||
197 | <listitem><para><emphasis> | ||
198 | <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis> | ||
199 | The bug tracking application the Yocto Project uses. | ||
200 | If you find problems with the Yocto Project, you should report them using this | ||
201 | application. | ||
202 | </para></listitem> | ||
203 | <listitem><para><emphasis>Yocto Project Mailing Lists:</emphasis> | ||
204 | To subscribe to the Yocto Project mailing | ||
205 | lists, click on the following URLs and follow the instructions: | ||
206 | <itemizedlist> | ||
207 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> | ||
208 | for a Yocto Project Discussions mailing list. | ||
209 | </para></listitem> | ||
210 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> | ||
211 | for a Yocto Project Discussions mailing list about the | ||
212 | OpenEmbedded build system (Poky). | ||
213 | </para></listitem> | ||
214 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> | ||
215 | for a mailing list to receive official Yocto Project announcements | ||
216 | as well as Yocto Project milestones. | ||
217 | </para></listitem> | ||
218 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> | ||
219 | for a listing of all public mailing lists on | ||
220 | <filename>lists.yoctoproject.org</filename>. | ||
221 | </para></listitem> | ||
222 | </itemizedlist></para></listitem> | ||
223 | <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis> | ||
224 | Two IRC channels on freenode are available | ||
225 | for Yocto Project and Poky discussions: <filename>#yocto</filename> and | ||
226 | <filename>#poky</filename>, respectively. | ||
227 | </para></listitem> | ||
228 | <listitem><para><emphasis> | ||
229 | <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> | ||
230 | The build system used by the Yocto Project. | ||
231 | This project is the upstream, generic, embedded distribution | ||
232 | from which the Yocto Project derives its build system (Poky) | ||
233 | and to which it contributes. | ||
234 | </para></listitem> | ||
235 | <listitem><para><emphasis> | ||
236 | <ulink url='http://www.openembedded.org/wiki/BitBake'>BitBake</ulink>:</emphasis> | ||
237 | The tool used by the OpenEmbedded build system | ||
238 | to process project metadata. | ||
239 | </para></listitem> | ||
240 | <listitem><para><emphasis> | ||
241 | <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis> | ||
242 | A comprehensive guide to the BitBake tool. | ||
243 | If you want information on BitBake, see this manual. | ||
244 | </para></listitem> | ||
245 | <listitem><para><emphasis> | ||
246 | <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:</emphasis> | ||
247 | An open-source machine emulator and virtualizer. | ||
248 | </para></listitem> | ||
249 | </itemizedlist> | ||
250 | </para> | 119 | </para> |
251 | </section> | 120 | </section> |
252 | </chapter> | 121 | </chapter> |
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index cec23b6039..7423467150 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml | |||
@@ -44,75 +44,114 @@ | |||
44 | <para> | 44 | <para> |
45 | This reference manual consists of the following: | 45 | This reference manual consists of the following: |
46 | <itemizedlist> | 46 | <itemizedlist> |
47 | <listitem><para><emphasis> | 47 | <listitem><para> |
48 | <link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis> | 48 | <emphasis> |
49 | Provides an overview of the components that make up the Yocto Project | 49 | <link linkend='usingpoky'>Using the Yocto Project</link>: |
50 | followed by information about debugging images created in the Yocto Project. | 50 | </emphasis> |
51 | Provides an overview of the components that make up the Yocto | ||
52 | Project followed by information about debugging images created | ||
53 | in the Yocto Project. | ||
51 | </para></listitem> | 54 | </para></listitem> |
52 | <listitem><para><emphasis> | 55 | <listitem><para> |
53 | <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>:</emphasis> | 56 | <emphasis> |
57 | <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>: | ||
58 | </emphasis> | ||
54 | Provides a more detailed look at the Yocto Project development | 59 | Provides a more detailed look at the Yocto Project development |
55 | environment within the context of development. | 60 | environment within the context of development. |
56 | </para></listitem> | 61 | </para></listitem> |
57 | <listitem><para><emphasis> | 62 | <listitem><para> |
58 | <link linkend='technical-details'>Technical Details</link>:</emphasis> | 63 | <emphasis> |
59 | Describes fundamental Yocto Project components as well as an explanation | 64 | <link linkend='technical-details'>Technical Details</link>: |
60 | behind how the Yocto Project uses shared state (sstate) cache to speed build time. | 65 | </emphasis> |
66 | Describes fundamental Yocto Project components as well as an | ||
67 | explanation behind how the Yocto Project uses shared state | ||
68 | (sstate) cache to speed build time. | ||
61 | </para></listitem> | 69 | </para></listitem> |
62 | <listitem><para><emphasis> | 70 | <listitem><para> |
63 | <link linkend='migration'>Migrating to a Newer Yocto Project Release</link>:</emphasis> | 71 | <emphasis> |
72 | <link linkend='migration'>Migrating to a Newer Yocto Project Release</link>: | ||
73 | </emphasis> | ||
64 | Describes release-specific information that helps you move from | 74 | Describes release-specific information that helps you move from |
65 | one Yocto Project Release to another. | 75 | one Yocto Project Release to another. |
66 | </para></listitem> | 76 | </para></listitem> |
67 | <listitem><para><emphasis> | 77 | <listitem><para> |
68 | <link linkend='ref-structure'>Directory Structure</link>:</emphasis> | 78 | <emphasis> |
69 | Describes the | 79 | <link linkend='ref-structure'>Directory Structure</link>: |
70 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> created | 80 | </emphasis> Describes the |
71 | either by unpacking a released Yocto Project tarball on your host development system, | 81 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
72 | or by cloning the upstream | 82 | created either by unpacking a released Yocto Project tarball on |
73 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. | 83 | your host development system, or by cloning the upstream |
84 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> | ||
85 | Git repository. | ||
74 | </para></listitem> | 86 | </para></listitem> |
75 | <listitem><para><emphasis> | 87 | <listitem><para> |
76 | <link linkend='ref-classes'>Classes</link>:</emphasis> | 88 | <emphasis> |
77 | Describes the classes used in the Yocto Project.</para></listitem> | 89 | <link linkend='ref-classes'>Classes</link>: |
78 | <listitem><para><emphasis> | 90 | </emphasis> |
79 | <link linkend='ref-tasks'>Tasks</link>:</emphasis> | 91 | Describes the classes used in the Yocto Project. |
92 | </para></listitem> | ||
93 | <listitem><para> | ||
94 | <emphasis> | ||
95 | <link linkend='ref-tasks'>Tasks</link>: | ||
96 | </emphasis> | ||
80 | Describes the tasks defined by the OpenEmbedded build system. | 97 | Describes the tasks defined by the OpenEmbedded build system. |
81 | </para></listitem> | 98 | </para></listitem> |
82 | <listitem><para><emphasis> | 99 | <listitem><para> |
83 | <link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>:</emphasis> | 100 | <emphasis> |
101 | <link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>: | ||
102 | </emphasis> | ||
84 | Provides a quick reference for the <filename>devtool</filename> | 103 | Provides a quick reference for the <filename>devtool</filename> |
85 | command. | 104 | command. |
86 | </para></listitem> | 105 | </para></listitem> |
87 | <listitem><para><emphasis> | 106 | <listitem><para> |
88 | <link linkend='ref-qa-checks'>QA Error and Warning Messages</link>:</emphasis> | 107 | <emphasis> |
108 | <link linkend='ref-qa-checks'>QA Error and Warning Messages</link>: | ||
109 | </emphasis> | ||
89 | Lists and describes QA warning and error messages. | 110 | Lists and describes QA warning and error messages. |
90 | </para></listitem> | 111 | </para></listitem> |
91 | <listitem><para><emphasis> | 112 | <listitem><para> |
92 | <link linkend='ref-images'>Images</link>:</emphasis> | 113 | <emphasis> |
114 | <link linkend='ref-images'>Images</link>: | ||
115 | </emphasis> | ||
93 | Describes the standard images that the Yocto Project supports. | 116 | Describes the standard images that the Yocto Project supports. |
94 | </para></listitem> | 117 | </para></listitem> |
95 | <listitem><para><emphasis> | 118 | <listitem><para> |
96 | <link linkend='ref-features'>Features</link>:</emphasis> | 119 | <emphasis> |
97 | Describes mechanisms for creating distribution, machine, and image | 120 | <link linkend='ref-features'>Features</link>: |
98 | features during the build process using the OpenEmbedded build system.</para></listitem> | 121 | </emphasis> |
99 | <listitem><para><emphasis> | 122 | Describes mechanisms for creating distribution, machine, and |
100 | <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis> | 123 | image features during the build process using the OpenEmbedded |
101 | Presents most variables used by the OpenEmbedded build system, which | 124 | build system. |
102 | uses BitBake. | 125 | </para></listitem> |
103 | Entries describe the function of the variable and how to apply them. | 126 | <listitem><para> |
127 | <emphasis> | ||
128 | <link linkend='ref-variables-glos'>Variables Glossary</link>: | ||
129 | </emphasis> | ||
130 | Presents most variables used by the OpenEmbedded build system, | ||
131 | which uses BitBake. | ||
132 | Entries describe the function of the variable and how to | ||
133 | apply them. | ||
134 | </para></listitem> | ||
135 | <listitem><para> | ||
136 | <emphasis> | ||
137 | <link linkend='ref-varlocality'>Variable Context</link>: | ||
138 | </emphasis> | ||
139 | Provides variable locality or context. | ||
140 | </para></listitem> | ||
141 | <listitem><para> | ||
142 | <emphasis> | ||
143 | <link linkend='faq'>FAQ</link>: | ||
144 | </emphasis> | ||
145 | Provides answers for commonly asked questions in the Yocto | ||
146 | Project development environment. | ||
147 | </para></listitem> | ||
148 | <listitem><para> | ||
149 | <emphasis> | ||
150 | <link linkend='resources'>Contributions and Additional Information</link>: | ||
151 | </emphasis> | ||
152 | Provides an overview of methods by which you can | ||
153 | contribute to and participate in the Yocto Project. | ||
104 | </para></listitem> | 154 | </para></listitem> |
105 | <listitem><para><emphasis> | ||
106 | <link linkend='ref-varlocality'>Variable Context</link>:</emphasis> | ||
107 | Provides variable locality or context.</para></listitem> | ||
108 | <listitem><para><emphasis> | ||
109 | <link linkend='faq'>FAQ</link>:</emphasis> | ||
110 | Provides answers for commonly asked questions in the Yocto Project | ||
111 | development environment.</para></listitem> | ||
112 | <listitem><para><emphasis> | ||
113 | <link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis> | ||
114 | Provides guidance on how you can contribute back to the Yocto | ||
115 | Project.</para></listitem> | ||
116 | </itemizedlist> | 155 | </itemizedlist> |
117 | </para> | 156 | </para> |
118 | </section> | 157 | </section> |
diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml index 0cd0e5a254..c713ffcf11 100644 --- a/documentation/ref-manual/resources.xml +++ b/documentation/ref-manual/resources.xml | |||
@@ -3,15 +3,31 @@ | |||
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | 4 | ||
5 | <chapter id='resources'> | 5 | <chapter id='resources'> |
6 | <title>Contributing to the Yocto Project</title> | 6 | <title>Contributions and Additional Information</title> |
7 | 7 | ||
8 | <section id='resources-intro'> | 8 | <section id='resources-intro'> |
9 | <title>Introduction</title> | 9 | <title>Introduction</title> |
10 | <para> | 10 | <para> |
11 | The Yocto Project team is happy for people to experiment with the Yocto Project. | 11 | The Yocto Project team is happy for people to experiment with the |
12 | A number of places exist to find help if you run into difficulties or find bugs. | 12 | Yocto Project. |
13 | To find out how to download source code, | 13 | A number of places exist to find help if you run into difficulties |
14 | see the "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto Project Release</ulink>" | 14 | or find bugs. |
15 | This presents information about contributing and participating in | ||
16 | the Yocto Project. | ||
17 | </para> | ||
18 | </section> | ||
19 | |||
20 | <section id='resources-contributions'> | ||
21 | <title>Contributions</title> | ||
22 | |||
23 | <para> | ||
24 | The Yocto Project gladly accepts contributions. | ||
25 | You can submit changes to the project either by creating and sending | ||
26 | pull requests, | ||
27 | or by submitting patches through email. | ||
28 | For information on how to do both as well as information on how | ||
29 | to identify the maintainer for each area of code, see the | ||
30 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>" | ||
15 | section in the Yocto Project Development Manual. | 31 | section in the Yocto Project Development Manual. |
16 | </para> | 32 | </para> |
17 | </section> | 33 | </section> |
@@ -100,53 +116,173 @@ | |||
100 | </para> | 116 | </para> |
101 | </section> | 117 | </section> |
102 | 118 | ||
103 | <section id='resources-links'> | 119 | <section id='resources-links-and-related-documentation'> |
104 | <title>Links</title> | 120 | <title>Links and Related Documentation</title> |
105 | 121 | ||
106 | <para> | 122 | <para> |
107 | Here is a list of resources you will find helpful: | 123 | Here is a list of resources you might find helpful: |
108 | <itemizedlist> | 124 | <itemizedlist> |
109 | <listitem><para><emphasis> | 125 | <listitem><para> |
126 | <emphasis> | ||
110 | <ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>: | 127 | <ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>: |
111 | </emphasis> The home site for the Yocto | 128 | </emphasis> The home site for the Yocto Project. |
112 | Project.</para></listitem> | 129 | </para></listitem> |
113 | <!-- | 130 | <listitem><para> |
114 | <listitem><para><emphasis> | 131 | <emphasis> |
115 | <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> | 132 | <ulink url='&YOCTO_WIKI_URL;/wiki/Main_Page'>The Yocto Project Main Wiki Page</ulink>: |
116 | The company that acquired OpenedHand in 2008 and began | 133 | </emphasis> |
117 | development on the Yocto Project.</para></listitem> | 134 | The main wiki page for the Yocto Project. |
118 | --> | 135 | This page contains information about project planning, |
119 | <listitem><para><emphasis> | 136 | release engineering, QA & automation, a reference |
120 | <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> | 137 | site map, and other resources related to the Yocto Project. |
121 | The upstream, generic, embedded distribution used as the basis | 138 | </para></listitem> |
122 | for the build system in the Yocto Project. | 139 | <listitem><para> |
123 | Poky derives from and contributes back to the OpenEmbedded | 140 | <emphasis> |
124 | project.</para></listitem> | 141 | <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>: |
125 | <listitem><para><emphasis> | 142 | </emphasis> |
143 | The build system used by the Yocto Project. | ||
144 | This project is the upstream, generic, embedded distribution | ||
145 | from which the Yocto Project derives its build system (Poky) | ||
146 | and to which it contributes. | ||
147 | </para></listitem> | ||
148 | <listitem><para> | ||
149 | <emphasis> | ||
126 | <ulink url='http://www.openembedded.org/wiki/BitBake'> | 150 | <ulink url='http://www.openembedded.org/wiki/BitBake'> |
127 | BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem> | 151 | BitBake</ulink>: |
152 | </emphasis> The tool used to process metadata. | ||
153 | </para></listitem> | ||
154 | <listitem><para> | ||
155 | <emphasis> | ||
156 | <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink> | ||
157 | </emphasis> | ||
158 | A comprehensive guide to the BitBake tool. | ||
159 | If you want information on BitBake, see this manual. | ||
160 | </para></listitem> | ||
161 | <listitem><para> | ||
162 | <emphasis> | ||
163 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>: | ||
164 | </emphasis> | ||
165 | This short document lets you get started | ||
166 | with the Yocto Project and quickly begin building an image. | ||
167 | </para></listitem> | ||
168 | <listitem><para> | ||
169 | <emphasis> | ||
170 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>: | ||
171 | </emphasis> | ||
172 | This manual is a "how-to" guide that presents procedures | ||
173 | useful to both application and system developers who use the | ||
174 | Yocto Project. | ||
175 | </para></listitem> | ||
176 | <listitem><para> | ||
177 | <emphasis> | ||
178 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>: | ||
179 | </emphasis> | ||
180 | This guide provides information that lets you get going | ||
181 | with the standard or extensible SDK. | ||
182 | An SDK, with its cross-development toolchains, allows you | ||
183 | to develop projects inside or outside of the Yocto Project | ||
184 | environment. | ||
185 | </para></listitem> | ||
186 | <listitem><para> | ||
187 | <emphasis> | ||
188 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>: | ||
189 | </emphasis> | ||
190 | This guide defines the structure for BSP components. | ||
191 | Having a commonly understood structure encourages | ||
192 | standardization. | ||
193 | </para></listitem> | ||
194 | <listitem><para> | ||
195 | <emphasis> | ||
196 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>: | ||
197 | </emphasis> | ||
198 | This manual describes how to work with Linux Yocto kernels as | ||
199 | well as provides a bit of conceptual information on the | ||
200 | construction of the Yocto Linux kernel tree. | ||
201 | </para></listitem> | ||
202 | <listitem><para> | ||
203 | <emphasis> | ||
204 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>: | ||
205 | </emphasis> | ||
206 | This manual presents a set of common and generally useful | ||
207 | tracing and profiling schemes along with their applications | ||
208 | (as appropriate) to each tool. | ||
209 | </para></listitem> | ||
210 | <listitem><para> | ||
211 | <emphasis> | ||
212 | <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-appendix-latest-yp-eclipse-plug-in'>Eclipse IDE Yocto Plug-in</ulink>: | ||
213 | </emphasis> | ||
214 | Instructions that demonstrate how an application developer | ||
215 | uses the Eclipse Yocto Project Plug-in feature within | ||
216 | the Eclipse IDE. | ||
217 | </para></listitem> | ||
218 | <listitem><para> | ||
219 | <emphasis> | ||
220 | <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>: | ||
221 | </emphasis> | ||
222 | A list of commonly asked questions and their answers. | ||
223 | </para></listitem> | ||
224 | <listitem><para> | ||
225 | <emphasis> | ||
226 | <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>: | ||
227 | </emphasis> | ||
228 | Features, updates and known issues for the current | ||
229 | release of the Yocto Project. | ||
230 | </para></listitem> | ||
231 | <listitem><para> | ||
232 | <emphasis> | ||
233 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>: | ||
234 | </emphasis> | ||
235 | An Application Programming Interface (API) and web-based | ||
236 | interface to the OpenEmbedded build system, which uses | ||
237 | BitBake, that reports build information. | ||
238 | </para></listitem> | ||
239 | <listitem><para> | ||
240 | <emphasis> | ||
241 | <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>: | ||
242 | </emphasis> | ||
243 | This manual introduces and describes how to set up and use | ||
244 | Toaster, which is a web interface to the Yocto Project's | ||
245 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-system-term'>OpenEmbedded Build System</ulink>. | ||
246 | </para></listitem> | ||
247 | <listitem><para> | ||
248 | <emphasis> | ||
249 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>: | ||
250 | </emphasis> | ||
251 | A virtual machine that | ||
252 | enables you to build and boot a custom embedded Linux image | ||
253 | with the Yocto Project using a non-Linux development system. | ||
254 | </para></listitem> | ||
255 | <listitem><para> | ||
256 | <emphasis> | ||
257 | <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>: | ||
258 | </emphasis> | ||
259 | The bug tracking application the Yocto Project uses. | ||
260 | If you find problems with the Yocto Project, you should report | ||
261 | them using this application. | ||
262 | </para></listitem> | ||
263 | <listitem><para> | ||
264 | <emphasis> | ||
265 | <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla Configuration and Bug Tracking Wiki Page</ulink>: | ||
266 | </emphasis> | ||
267 | Information on how to get set up and use the Yocto Project | ||
268 | implementation of Bugzilla for logging and tracking Yocto | ||
269 | Project defects. | ||
270 | </para></listitem> | ||
271 | <listitem><para> | ||
272 | <emphasis>Internet Relay Chat (IRC):</emphasis> | ||
273 | Two IRC channels on freenode are available | ||
274 | for Yocto Project and Poky discussions: <filename>#yocto</filename> and | ||
275 | <filename>#poky</filename>, respectively. | ||
276 | </para></listitem> | ||
277 | <listitem><para> | ||
278 | <emphasis> | ||
279 | <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>: | ||
280 | </emphasis> | ||
281 | An open-source machine emulator and virtualizer. | ||
282 | </para></listitem> | ||
128 | </itemizedlist> | 283 | </itemizedlist> |
129 | For more links, see the | ||
130 | "<ulink url='&YOCTO_DOCS_DEV_URL;#other-information'>Other Information</ulink>" | ||
131 | section in the Yocto Project Development Manual. | ||
132 | </para> | ||
133 | </section> | ||
134 | |||
135 | <section id='resources-contributions'> | ||
136 | <title>Contributions</title> | ||
137 | |||
138 | <para> | ||
139 | The Yocto Project gladly accepts contributions. | ||
140 | You can submit changes to the project either by creating and sending | ||
141 | pull requests, | ||
142 | or by submitting patches through email. | ||
143 | For information on how to do both as well as information on how | ||
144 | to identify the maintainer for each area of code, see the | ||
145 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>" | ||
146 | section in the Yocto Project Development Manual. | ||
147 | </para> | 284 | </para> |
148 | </section> | 285 | </section> |
149 | |||
150 | </chapter> | 286 | </chapter> |
151 | <!-- | 287 | <!-- |
152 | vim: expandtab tw=80 ts=4 | 288 | vim: expandtab tw=80 ts=4 |