Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openbmc / 36acd3e888044dea2ac0b2946f15616f968388c9 / . / import-layers / yocto-poky / documentation / mega-manual / mega-manual.xml
blob: a941d799a1937b88667077d8b8e37be5c508e20f [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 Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]74 <revnumber>2.4.1</revnumber>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500[diff] [blame]75 <date>January 2018</date>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]76 <revremark>Released with the Yocto Project 2.4.1 Release.</revremark>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500[diff] [blame]77 </revision>
78 <revision>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]79 <revnumber>2.4.2</revnumber>
80 <date>March 2018</date>
81 <revremark>Released with the Yocto Project 2.4.2 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500[diff] [blame]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
103 for this release, use the manual from the
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500[diff] [blame]104 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>.
105 </para></listitem>
106 <listitem><para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]107 For manuals associated with other releases of the Yocto
108 Project, 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>
110 and use the drop-down "Active Releases" button
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]111 and choose the manual associated with the desired
112 Yocto Project.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500[diff] [blame]113 </para></listitem>
114 <listitem><para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]115 To report any inaccuracies or problems with this
116 manual, send an email to the Yocto Project
117 discussion group at
118 <filename>yocto@yoctoproject.com</filename> or log into
119 the freenode <filename>#yocto</filename> channel.
120 </para></listitem>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500[diff] [blame]121 </itemizedlist>
122 </note>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]123
124 </legalnotice>
125
126 </bookinfo>
127
128<!-- Includes yocto-project-qs -->
129
130 <xi:include
131 xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/yocto-project-qs.xml"/>
132
133<!-- Includes dev-manual title image and then dev-manual chapters -->
134
135 <para>
136 <imagedata fileref="figures/dev-title.png" width="100%" align="left" scalefit="1" />
137 </para>
138
139 <xi:include
140 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-intro.xml"/>
141 <xi:include
142 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-start.xml"/>
143 <xi:include
144 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-newbie.xml"/>
145 <xi:include
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]146 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-common-tasks.xml"/>
147 <xi:include
148 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-qemu.xml"/>
149
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]150<!-- Includes sdk-manual title image and then sdk-manual chapters -->
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]151
152 <para>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]153 <imagedata fileref="figures/sdk-title.png" width="100%" align="left" scalefit="1" />
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]154 </para>
155
156 <xi:include
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]157 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-intro.xml"/>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]158 <xi:include
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600[diff] [blame]159 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-extensible.xml"/>
160 <xi:include
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]161 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-using.xml"/>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]162 <xi:include
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600[diff] [blame]163 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]164 <xi:include
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]165 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-eclipse-project.xml"/>
166 <xi:include
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]167 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]168 <xi:include
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500[diff] [blame]169 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]170 <xi:include
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500[diff] [blame]171 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/>
172 <xi:include
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600[diff] [blame]173 xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-mars.xml"/>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]174
175<!-- Includes bsp-guide title image and then bsp-guide chapters -->
176
177 <para>
178 <imagedata fileref="figures/bsp-title.png" width="100%" align="left" scalefit="1" />
179 </para>
180
181 <xi:include
182 xmlns:xi="http://www.w3.org/2003/XInclude" href="../bsp-guide/bsp.xml"/>
183
184<!-- Includes kernel-dev title image and then kernel-dev chapters -->
185
186 <para>
187 <imagedata fileref="figures/kernel-dev-title.png" width="100%" align="left" scalefit="1" />
188 </para>
189
190 <xi:include
191 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-intro.xml"/>
192 <xi:include
193 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-common.xml"/>
194 <xi:include
195 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-advanced.xml"/>
196 <xi:include
197 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-concepts-appx.xml"/>
198 <xi:include
199 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-maint-appx.xml"/>
200
201<!-- Includes profile-manual title image and then profile-manual chapters -->
202
203 <para>
204 <imagedata fileref="figures/profile-title.png" width="100%" align="left" scalefit="1" />
205 </para>
206
207 <xi:include
208 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-intro.xml"/>
209 <xi:include
210 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-arch.xml"/>
211 <xi:include
212 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-usage.xml"/>
213 <xi:include
214 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-examples.xml"/>
215
216<!-- Includes ref-manual title image and then ref-manual chapters -->
217
218 <para>
219 <imagedata fileref="figures/poky-title.png" width="100%" align="left" scalefit="1" />
220 </para>
221
222 <xi:include
223 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/introduction.xml"/>
224
225 <xi:include
226 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/usingpoky.xml"/>
227
228 <xi:include
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]229 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-development-environment.xml"/>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]230
231 <xi:include
232 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/technical-details.xml"/>
233
234 <xi:include
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500[diff] [blame]235 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-release-process.xml"/>
236
237 <xi:include
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]238 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/migration.xml"/>
239
240 <xi:include
241 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-structure.xml"/>
242
243 <xi:include
244 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-classes.xml"/>
245
246 <xi:include
247 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-tasks.xml"/>
248
249 <xi:include
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600[diff] [blame]250 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/>
251
252 <xi:include
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500[diff] [blame]253 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-kickstart.xml"/>
254
255 <xi:include
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500[diff] [blame]256 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/>
257
258 <xi:include
259 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-images.xml"/>
260
261 <xi:include
262 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-features.xml"/>
263
264 <xi:include
265 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-variables.xml"/>
266
267 <xi:include
268 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-varlocality.xml"/>
269
270 <xi:include
271 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/faq.xml"/>
272
273 <xi:include
274 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/resources.xml"/>
275
276<!-- Includes toaster-manual title image and then toaster-manual chapters -->
277
278 <para>
279 <imagedata fileref="figures/toaster-title.png" width="100%" align="left" scalefit="1" />
280 </para>
281
282 <xi:include
283 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-intro.xml"/>
284
285 <xi:include
286 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-start.xml"/>
287
288 <xi:include
289 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-setup-and-use.xml"/>
290
291 <xi:include
292 xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/>
293
294</book>
295
296<!--
297vim: expandtab tw=80 ts=4
298-->