summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-manual.xml
blob: 6c7403dc0da42ad7bb3385b5bf07ace05d56ba53 (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
<!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='ref-manual' lang='en'
      xmlns:xi="http://www.w3.org/2003/XInclude"
      xmlns="http://docbook.org/ns/docbook"
      >
    <bookinfo>

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

        <title>
            Yocto Project Reference 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>4.0+git</revnumber>
                <date>24 November 2010</date>
                <revremark>Released with the Yocto Project 0.9 Release</revremark>
            </revision>
            <revision>
                <revnumber>1.0</revnumber>
                <date>6 April 2011</date>
                <revremark>Released with the Yocto Project 1.0 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.0.1</revnumber>
                <date>23 May 2011</date>
                <revremark>Released with the Yocto Project 1.0.1 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.1</revnumber>
                <date>6 October 2011</date>
                <revremark>Released with the Yocto Project 1.1 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.2</revnumber>
                <date>April 2012</date>
                <revremark>Released with the Yocto Project 1.2 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.3</revnumber>
                <date>October 2012</date>
                <revremark>Released with the Yocto Project 1.3 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.4</revnumber>
                <date>April 2013</date>
                <revremark>Released with the Yocto Project 1.4 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.5</revnumber>
                <date>October 2013</date>
                <revremark>Released with the Yocto Project 1.5 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.5.1</revnumber>
                <date>January 2014</date>
                <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.6</revnumber>
                <date>April 2014</date>
                <revremark>Released with the Yocto Project 1.6 Release.</revremark>
            </revision>
            <revision>
                <revnumber>1.7</revnumber>
                <date>October 2014</date>
                <revremark>Released with the Yocto Project 1.7 Release.</revremark>
            </revision>
            <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>
        </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 Reference 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>

    <xi:include href="introduction.xml"/>

    <xi:include href="usingpoky.xml"/>

    <xi:include href="ref-development-environment.xml"/>

    <xi:include href="technical-details.xml"/>

    <xi:include href="ref-release-process.xml"/>

    <xi:include href="migration.xml"/>

    <xi:include href="ref-structure.xml"/>

    <xi:include href="ref-classes.xml"/>

    <xi:include href="ref-tasks.xml"/>

    <xi:include href="ref-devtool-reference.xml"/>

    <xi:include href="ref-kickstart.xml"/>

    <xi:include href="ref-qa-checks.xml"/>

    <xi:include href="ref-images.xml"/>

    <xi:include href="ref-features.xml"/>

    <xi:include href="ref-variables.xml"/>

    <xi:include href="ref-varlocality.xml"/>

    <xi:include href="faq.xml"/>

    <xi:include href="resources.xml"/>

<!--    <index id='index'>
      <title>Index</title>
    </index>
-->

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