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