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