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