summaryrefslogtreecommitdiffstats
path: root/documentation/mega-manual/mega-manual.xml
blob: 15402722ab448800f2151a0c2c8cf0e798175d54 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >


<book id='mega-manual' lang='en'
      xmlns:xi="http://www.w3.org/2003/XInclude"
      xmlns="http://docbook.org/ns/docbook"
      >

    <bookinfo>

        <abstract>
            The Yocto Project Mega-Manual is a concatenation of the published
            Yocto Project HTML manuals for the given release.
            The manual exists to help users efficiently search for strings
            across the entire Yocto Project documentation set.
        </abstract>

        <mediaobject>
            <imageobject>
                <imagedata fileref='figures/mega-title.png'
                    format='SVG'
                    align='left' scalefit='1' width='100%'/>
            </imageobject>
        </mediaobject>

        <title>
            Yocto Project Mega-Manual
        </title>

        <authorgroup>
            <author>
                <firstname>Scott</firstname> <surname>Rifenbark</surname>
                <affiliation>
                    <orgname>Scotty's Documentation Services, INC</orgname>
                </affiliation>
                <email>srifenbark@gmail.com</email>
            </author>
        </authorgroup>

        <revhistory>
            <revision>
                <revnumber>1.8</revnumber>
                <date>April 2015</date>
                <revremark>Released with the Yocto Project 1.8 Release.</revremark>
            </revision>
            <revision>
                <revnumber>2.0</revnumber>
                <date>October 2015</date>
                <revremark>Released with the Yocto Project 2.0 Release.</revremark>
            </revision>
            <revision>
                <revnumber>2.1</revnumber>
                <date>April 2016</date>
                <revremark>Released with the Yocto Project 2.1 Release.</revremark>
            </revision>
            <revision>
                <revnumber>2.2</revnumber>
                <date>October 2016</date>
                <revremark>Released with the Yocto Project 2.2 Release.</revremark>
            </revision>
            <revision>
                <revnumber>2.3</revnumber>
                <date>May 2017</date>
                <revremark>Released with the Yocto Project 2.3 Release.</revremark>
            </revision>
            <revision>
                <revnumber>2.4</revnumber>
                <date>October 2017</date>
                <revremark>Released with the Yocto Project 2.4 Release.</revremark>
            </revision>
            <revision>
                <revnumber>2.5</revnumber>
                <date>April 2018</date>
                <revremark>Released with the Yocto Project 2.5 Release.</revremark>
            </revision>
       </revhistory>

    <copyright>
      <year>&COPYRIGHT_YEAR;</year>
      <holder>Linux Foundation</holder>
    </copyright>

    <legalnotice>
      <para>
        Permission is granted to copy, distribute and/or modify this document under
        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.
      </para>
           <note><title>Manual Notes</title>
               <itemizedlist>
                   <listitem><para>
                       This version of the
                       <emphasis>Yocto Project Mega-Manual</emphasis>
                       is for the &YOCTO_DOC_VERSION; release of the
                       Yocto Project.
                       To be sure you have the latest version of the manual
                       for this release, use the manual from the
                       <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>.
                       </para></listitem>
                   <listitem><para>
                       For manuals associated with other releases of the Yocto
                       Project, go to the
                       <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
                       and use the drop-down "Active Releases" button
                       and choose the manual associated with the desired
                       Yocto Project.
                       </para></listitem>
                   <listitem><para>
                        To report any inaccuracies or problems with this
                        manual, send an email to the Yocto Project
                        discussion group at
                        <filename>yocto@yoctoproject.com</filename> or log into
                        the freenode <filename>#yocto</filename> channel.
                        </para></listitem>
               </itemizedlist>
           </note>

    </legalnotice>

    </bookinfo>

<!-- Includes yocto-project-qs -->

    <para>
        <imagedata fileref="figures/ypqs-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/qs.xml"/>

<!-- Includes getting-started title image and then getting-started chapters -->

    <para>
        <imagedata fileref="figures/getting-started-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../getting-started/getting-started-intro.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../getting-started/getting-started-yp-intro.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../getting-started/getting-started-development-environment.xml"/>

<!-- Includes concepts-manual title image and then concepts-manual chapters -->

    <para>
        <imagedata fileref="figures/concepts-manual-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../concepts-manual/concepts-manual-intro.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../concepts-manual/concepts-manual-concepts.xml"/>

<!-- Includes dev-manual title image and then dev-manual chapters -->

    <para>
        <imagedata fileref="figures/dev-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-intro.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-start.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-newbie.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-common-tasks.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-qemu.xml"/>

<!-- Includes sdk-manual title image and then sdk-manual chapters -->

    <para>
        <imagedata fileref="figures/sdk-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-intro.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-extensible.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-using.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-working-projects.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-eclipse-project.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-obtain.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-mars.xml"/>

<!-- Includes bsp-guide title image and then bsp-guide chapters -->

    <para>
        <imagedata fileref="figures/bsp-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../bsp-guide/bsp.xml"/>

<!-- Includes kernel-dev title image and then kernel-dev chapters -->

    <para>
        <imagedata fileref="figures/kernel-dev-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-intro.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-common.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-advanced.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-concepts-appx.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-maint-appx.xml"/>

<!-- Includes profile-manual title image and then profile-manual chapters -->

    <para>
        <imagedata fileref="figures/profile-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-intro.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-arch.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-usage.xml"/>
    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-examples.xml"/>

<!-- Includes ref-manual title image and then ref-manual chapters -->

    <para>
        <imagedata fileref="figures/poky-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-system-requirements.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-terms.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-release-process.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/migration.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-structure.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-classes.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-tasks.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-kickstart.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-images.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-features.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-variables.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-varlocality.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/faq.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/resources.xml"/>

<!-- Includes toaster-manual title image and then toaster-manual chapters -->

    <para>
        <imagedata fileref="figures/toaster-title.png" width="100%" align="left" scalefit="1" />
    </para>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-intro.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-start.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-setup-and-use.xml"/>

    <xi:include
        xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/>

</book>

<!--
vim: expandtab tw=80 ts=4
-->