blob: f5f2e3fd0e20d35fa71f0331a0ec93f897290bcd [file] [log] [blame]
rjw1f884582022-01-06 17:20:42 +08001<!DOCTYPE book 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
6<book id='mega-manual' lang='en'
7 xmlns:xi="http://www.w3.org/2003/XInclude"
8 xmlns="http://docbook.org/ns/docbook"
9 >
10
11 <bookinfo>
12
13 <abstract>
14 The Yocto Project Mega-Manual is a concatenation of the published
15 Yocto Project HTML manuals for the given release.
16 The manual exists to help users efficiently search for strings
17 across the entire Yocto Project documentation set.
18 </abstract>
19
20 <mediaobject>
21 <imageobject>
22 <imagedata fileref='figures/mega-title.png'
23 format='SVG'
24 align='left' scalefit='1' width='100%'/>
25 </imageobject>
26 </mediaobject>
27
28 <title>
29 Yocto Project Mega-Manual
30 </title>
31
32 <authorgroup>
33 <author>
34 <firstname>Scott</firstname> <surname>Rifenbark</surname>
35 <affiliation>
36 <orgname>Scotty's Documentation Services, INC</orgname>
37 </affiliation>
38 <email>srifenbark@gmail.com</email>
39 </author>
40 </authorgroup>
41
42 <revhistory>
43 <revision>
44 <revnumber>1.8</revnumber>
45 <date>April 2015</date>
46 <revremark>Released with the Yocto Project 1.8 Release.</revremark>
47 </revision>
48 <revision>
49 <revnumber>2.0</revnumber>
50 <date>October 2015</date>
51 <revremark>Released with the Yocto Project 2.0 Release.</revremark>
52 </revision>
53 <revision>
54 <revnumber>2.1</revnumber>
55 <date>April 2016</date>
56 <revremark>Released with the Yocto Project 2.1 Release.</revremark>
57 </revision>
58 <revision>
59 <revnumber>2.2</revnumber>
60 <date>October 2016</date>
61 <revremark>Released with the Yocto Project 2.2 Release.</revremark>
62 </revision>
63 <revision>
64 <revnumber>2.3</revnumber>
65 <date>May 2017</date>
66 <revremark>Released with the Yocto Project 2.3 Release.</revremark>
67 </revision>
68 <revision>
69 <revnumber>2.4</revnumber>
70 <date>October 2017</date>
71 <revremark>Released with the Yocto Project 2.4 Release.</revremark>
72 </revision>
73 <revision>
74 <revnumber>2.5</revnumber>
75 <date>May 2018</date>
76 <revremark>Released with the Yocto Project 2.5 Release.</revremark>
77 </revision>
78 <revision>
79 <revnumber>2.6</revnumber>
80 <date>November 2018</date>
81 <revremark>Released with the Yocto Project 2.6 Release.</revremark>
82 </revision>
83 <revision>
84 <revnumber>2.6.1</revnumber>
85 <date>February 2019</date>
86 <revremark>Released with the Yocto Project 2.6.1 Release.</revremark>
87 </revision>
88 <revision>
89 <revnumber>2.6.2</revnumber>
90 <date>April 2019</date>
91 <revremark>Released with the Yocto Project 2.6.2 Release.</revremark>
92 </revision>
93 <revision>
94 <revnumber>2.6.3</revnumber>
95 <date>August 2019</date>
96 <revremark>Released with the Yocto Project 2.6.3 Release.</revremark>
97 </revision>
98 </revhistory>
99
100 <copyright>
101 <year>&COPYRIGHT_YEAR;</year>
102 <holder>Linux Foundation</holder>
103 </copyright>
104
105 <legalnotice>
106 <para>
107 Permission is granted to copy, distribute and/or modify this document under
108 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
109 </para>
110 <note><title>Manual Notes</title>
111 <itemizedlist>
112 <listitem><para>
113 This version of the
114 <emphasis>Yocto Project Mega-Manual</emphasis>
115 is for the &YOCTO_DOC_VERSION; release of the
116 Yocto Project.
117 To be sure you have the latest version of the manual
118 for this release, go to the
119 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
120 and select the manual from that site.
121 Manuals from the site are more up-to-date than manuals
122 derived from the Yocto Project released TAR files.
123 </para></listitem>
124 <listitem><para>
125 If you located this manual through a web search, the
126 version of the manual might not be the one you want
127 (e.g. the search might have returned a manual much
128 older than the Yocto Project version with which you
129 are working).
130 You can see all Yocto Project major releases by
131 visiting the
132 <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
133 page.
134 If you need a version of this manual for a different
135 Yocto Project release, visit the
136 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
137 and select the manual set by using the
138 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
139 pull-down menus.
140 </para></listitem>
141 <listitem><para>
142 To report any inaccuracies or problems with this
143 manual, send an email to the Yocto Project
144 discussion group at
145 <filename>yocto@yoctoproject.com</filename> or log into
146 the freenode <filename>#yocto</filename> channel.
147 </para></listitem>
148 </itemizedlist>
149 </note>
150
151 </legalnotice>
152
153 </bookinfo>
154
155<!-- Includes brief-yoctoprojectqs -->
156
157 <para>
158 <imagedata fileref="figures/bypqs-title.png" width="100%" align="left" scalefit="1" />
159 </para>
160
161 <xi:include
162 xmlns:xi="http://www.w3.org/2003/XInclude" href="../brief-yoctoprojectqs/brief-yoctoprojectqs.xml"/>
163
164<!-- Includes overview-manual title image and then overview-manual chapters -->
165
166 <para>
167 <imagedata fileref="figures/overview-manual-title.png" width="100%" align="left" scalefit="1" />
168 </para>
169
170 <xi:include
171 xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-intro.xml"/>
172
173 <xi:include
174 xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-yp-intro.xml"/>
175
176 <xi:include
177 xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-development-environment.xml"/>
178
179 <xi:include
180 xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-concepts.xml"/>
181
182<!-- Includes dev-manual title image and then dev-manual chapters -->
183
184 <para>
185 <imagedata fileref="figures/dev-title.png" width="100%" align="left" scalefit="1" />
186 </para>
187
188 <xi:include
189 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-intro.xml"/>
190 <xi:include
191 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-start.xml"/>
192 <xi:include
193 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-common-tasks.xml"/>
194 <xi:include
195 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-qemu.xml"/>
196
197<!-- Includes sdk-manual title image and then sdk-manual chapters -->
198
199 <para>
200 <imagedata fileref="figures/sdk-title.png" width="100%" align="left" scalefit="1" />
201 </para>
202
203 <xi:include
204 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-intro.xml"/>
205 <xi:include
206 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-extensible.xml"/>
207 <xi:include
208 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-using.xml"/>
209 <xi:include
210 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-working-projects.xml"/>
211 <xi:include
212 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-eclipse-project.xml"/>
213 <xi:include
214 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-obtain.xml"/>
215 <xi:include
216 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/>
217 <xi:include
218 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/>
219 <xi:include
220 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-neon.xml"/>
221
222<!-- Includes bsp-guide title image and then bsp-guide chapters -->
223
224 <para>
225 <imagedata fileref="figures/bsp-title.png" width="100%" align="left" scalefit="1" />
226 </para>
227
228 <xi:include
229 xmlns:xi="http://www.w3.org/2003/XInclude" href="../bsp-guide/bsp.xml"/>
230
231<!-- Includes kernel-dev title image and then kernel-dev chapters -->
232
233 <para>
234 <imagedata fileref="figures/kernel-dev-title.png" width="100%" align="left" scalefit="1" />
235 </para>
236
237 <xi:include
238 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-intro.xml"/>
239 <xi:include
240 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-common.xml"/>
241 <xi:include
242 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-advanced.xml"/>
243 <xi:include
244 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-concepts-appx.xml"/>
245 <xi:include
246 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-maint-appx.xml"/>
247
248<!-- Includes profile-manual title image and then profile-manual chapters -->
249
250 <para>
251 <imagedata fileref="figures/profile-title.png" width="100%" align="left" scalefit="1" />
252 </para>
253
254 <xi:include
255 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-intro.xml"/>
256 <xi:include
257 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-arch.xml"/>
258 <xi:include
259 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-usage.xml"/>
260 <xi:include
261 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-examples.xml"/>
262
263<!-- Includes ref-manual title image and then ref-manual chapters -->
264
265 <para>
266 <imagedata fileref="figures/poky-title.png" width="100%" align="left" scalefit="1" />
267 </para>
268
269 <xi:include
270 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-system-requirements.xml"/>
271
272 <xi:include
273 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-terms.xml"/>
274
275 <xi:include
276 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-release-process.xml"/>
277
278 <xi:include
279 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/migration.xml"/>
280
281 <xi:include
282 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-structure.xml"/>
283
284 <xi:include
285 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-classes.xml"/>
286
287 <xi:include
288 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-tasks.xml"/>
289
290 <xi:include
291 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/>
292
293 <xi:include
294 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-kickstart.xml"/>
295
296 <xi:include
297 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/>
298
299 <xi:include
300 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-images.xml"/>
301
302 <xi:include
303 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-features.xml"/>
304
305 <xi:include
306 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-variables.xml"/>
307
308 <xi:include
309 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-varlocality.xml"/>
310
311 <xi:include
312 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/faq.xml"/>
313
314 <xi:include
315 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/resources.xml"/>
316
317<!-- Includes toaster-manual title image and then toaster-manual chapters -->
318
319 <para>
320 <imagedata fileref="figures/toaster-title.png" width="100%" align="left" scalefit="1" />
321 </para>
322
323 <xi:include
324 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-intro.xml"/>
325
326 <xi:include
327 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-start.xml"/>
328
329 <xi:include
330 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-setup-and-use.xml"/>
331
332 <xi:include
333 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/>
334
335</book>
336
337<!--
338vim: expandtab tw=80 ts=4
339-->