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