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