blob: fc4319773b7c09c454638e01cac4ac0c062164aa [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001<!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<book id='ref-manual' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/poky-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Reference Manual
21 </title>
22
23 <authorgroup>
24 <author>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050025 <firstname>Scott</firstname> <surname>Rifenbark</surname>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050026 <affiliation>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050027 <orgname>Scotty's Documentation Services, INC</orgname>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050028 </affiliation>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050029 <email>srifenbark@gmail.com</email>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050030 </author>
31
32 </authorgroup>
33
34 <revhistory>
35 <revision>
36 <revnumber>4.0+git</revnumber>
37 <date>24 November 2010</date>
38 <revremark>Released with the Yocto Project 0.9 Release</revremark>
39 </revision>
40 <revision>
41 <revnumber>1.0</revnumber>
42 <date>6 April 2011</date>
43 <revremark>Released with the Yocto Project 1.0 Release.</revremark>
44 </revision>
45 <revision>
46 <revnumber>1.0.1</revnumber>
47 <date>23 May 2011</date>
48 <revremark>Released with the Yocto Project 1.0.1 Release.</revremark>
49 </revision>
50 <revision>
51 <revnumber>1.1</revnumber>
52 <date>6 October 2011</date>
53 <revremark>Released with the Yocto Project 1.1 Release.</revremark>
54 </revision>
55 <revision>
56 <revnumber>1.2</revnumber>
57 <date>April 2012</date>
58 <revremark>Released with the Yocto Project 1.2 Release.</revremark>
59 </revision>
60 <revision>
61 <revnumber>1.3</revnumber>
62 <date>October 2012</date>
63 <revremark>Released with the Yocto Project 1.3 Release.</revremark>
64 </revision>
65 <revision>
66 <revnumber>1.4</revnumber>
67 <date>April 2013</date>
68 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
69 </revision>
70 <revision>
71 <revnumber>1.5</revnumber>
72 <date>October 2013</date>
73 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
74 </revision>
75 <revision>
76 <revnumber>1.5.1</revnumber>
77 <date>January 2014</date>
78 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
79 </revision>
80 <revision>
81 <revnumber>1.6</revnumber>
82 <date>April 2014</date>
83 <revremark>Released with the Yocto Project 1.6 Release.</revremark>
84 </revision>
85 <revision>
86 <revnumber>1.7</revnumber>
87 <date>October 2014</date>
88 <revremark>Released with the Yocto Project 1.7 Release.</revremark>
89 </revision>
90 <revision>
91 <revnumber>1.8</revnumber>
92 <date>April 2015</date>
93 <revremark>Released with the Yocto Project 1.8 Release.</revremark>
94 </revision>
95 <revision>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050096 <revnumber>2.0</revnumber>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050097 <date>October 2015</date>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050098 <revremark>Released with the Yocto Project 2.0 Release.</revremark>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050099 </revision>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500100 <revision>
101 <revnumber>2.1</revnumber>
102 <date>April 2016</date>
103 <revremark>Released with the Yocto Project 2.1 Release.</revremark>
104 </revision>
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600105 <revision>
106 <revnumber>2.2</revnumber>
107 <date>October 2016</date>
108 <revremark>Released with the Yocto Project 2.2 Release.</revremark>
109 </revision>
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500110 <revision>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500111 <revnumber>2.3</revnumber>
112 <date>May 2017</date>
113 <revremark>Released with the Yocto Project 2.3 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500114 </revision>
115 <revision>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500116 <revnumber>2.4</revnumber>
117 <date>October 2017</date>
118 <revremark>Released with the Yocto Project 2.4 Release.</revremark>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500119 </revision>
120 <revision>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400121 <revnumber>2.5</revnumber>
122 <date>May 2018</date>
123 <revremark>Released with the Yocto Project 2.5 Release.</revremark>
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500124 </revision>
Brad Bishopd5ae7d92018-06-14 09:52:03 -0700125 <revision>
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800126 <revnumber>2.6</revnumber>
127 <date>November 2018</date>
128 <revremark>Released with the Yocto Project 2.6 Release.</revremark>
Brad Bishopd5ae7d92018-06-14 09:52:03 -0700129 </revision>
Brad Bishopf86d0552018-12-04 14:18:15 -0800130 <revision>
Brad Bishop19323692019-04-05 15:28:33 -0400131 <revnumber>2.7</revnumber>
Brad Bishopc342db32019-05-15 21:57:59 -0400132 <date>May 2019</date>
Brad Bishop19323692019-04-05 15:28:33 -0400133 <revremark>Released with the Yocto Project 2.7 Release.</revremark>
Brad Bishopf86d0552018-12-04 14:18:15 -0800134 </revision>
Brad Bishopc342db32019-05-15 21:57:59 -0400135 <revision>
136 <revnumber>2.8</revnumber>
137 <date>&REL_MONTH_YEAR;</date>
138 <revremark>Released with the Yocto Project 2.8 Release.</revremark>
139 </revision>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500140 </revhistory>
141
142 <copyright>
143 <year>&COPYRIGHT_YEAR;</year>
144 <holder>Linux Foundation</holder>
145 </copyright>
146
147 <legalnotice>
148 <para>
149 Permission is granted to copy, distribute and/or modify this document under
150 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.
151 </para>
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500152 <note><title>Manual Notes</title>
153 <itemizedlist>
154 <listitem><para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500155 This version of the
156 <emphasis>Yocto Project Reference Manual</emphasis>
157 is for the &YOCTO_DOC_VERSION; release of the
158 Yocto Project.
159 To be sure you have the latest version of the manual
Brad Bishop316dfdd2018-06-25 12:45:53 -0400160 for this release, go to the
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500161 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400162 and select the manual from that site.
163 Manuals from the site are more up-to-date than manuals
164 derived from the Yocto Project released TAR files.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500165 </para></listitem>
166 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400167 If you located this manual through a web search, the
168 version of the manual might not be the one you want
169 (e.g. the search might have returned a manual much
170 older than the Yocto Project version with which you
171 are working).
172 You can see all Yocto Project major releases by
173 visiting the
174 <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
175 page.
176 If you need a version of this manual for a different
177 Yocto Project release, visit the
178 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
179 and select the manual set by using the
180 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
181 pull-down menus.
182 </para></listitem>
183 <listitem><para>
184 To report any inaccuracies or problems with this
185 manual, send an email to the Yocto Project
186 discussion group at
187 <filename>yocto@yoctoproject.com</filename> or log into
188 the freenode <filename>#yocto</filename> channel.
189 </para></listitem>
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500190 </itemizedlist>
191 </note>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500192 </legalnotice>
193
194 </bookinfo>
195
Brad Bishop316dfdd2018-06-25 12:45:53 -0400196 <xi:include href="ref-system-requirements.xml"/>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500197
Brad Bishop316dfdd2018-06-25 12:45:53 -0400198 <xi:include href="ref-terms.xml"/>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500199
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500200 <xi:include href="ref-release-process.xml"/>
201
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500202 <xi:include href="migration.xml"/>
203
204 <xi:include href="ref-structure.xml"/>
205
206 <xi:include href="ref-classes.xml"/>
207
208 <xi:include href="ref-tasks.xml"/>
209
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600210 <xi:include href="ref-devtool-reference.xml"/>
211
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500212 <xi:include href="ref-kickstart.xml"/>
213
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500214 <xi:include href="ref-qa-checks.xml"/>
215
216 <xi:include href="ref-images.xml"/>
217
218 <xi:include href="ref-features.xml"/>
219
220 <xi:include href="ref-variables.xml"/>
221
222 <xi:include href="ref-varlocality.xml"/>
223
224 <xi:include href="faq.xml"/>
225
226 <xi:include href="resources.xml"/>
227
228<!-- <index id='index'>
229 <title>Index</title>
230 </index>
231-->
232
233</book>
234<!--
235vim: expandtab tw=80 ts=4
236-->