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