Patrick Williams | c124f4f | 2015-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 | <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> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 25 | <affiliation> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 26 | <orgname>&ORGNAME;</orgname> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 27 | </affiliation> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 28 | <email>&ORGEMAIL;</email> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 29 | </author> |
| 30 | |
| 31 | </authorgroup> |
| 32 | |
| 33 | <revhistory> |
| 34 | <revision> |
| 35 | <revnumber>4.0+git</revnumber> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 36 | <date>November 2010</date> |
| 37 | <revremark>The initial document released with the Yocto Project 0.9 Release</revremark> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 38 | </revision> |
| 39 | <revision> |
| 40 | <revnumber>1.0</revnumber> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 41 | <date>April 2011</date> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 42 | <revremark>Released with the Yocto Project 1.0 Release.</revremark> |
| 43 | </revision> |
| 44 | <revision> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 45 | <revnumber>1.1</revnumber> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 46 | <date>October 2011</date> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 47 | <revremark>Released with the Yocto Project 1.1 Release.</revremark> |
| 48 | </revision> |
| 49 | <revision> |
| 50 | <revnumber>1.2</revnumber> |
| 51 | <date>April 2012</date> |
| 52 | <revremark>Released with the Yocto Project 1.2 Release.</revremark> |
| 53 | </revision> |
| 54 | <revision> |
| 55 | <revnumber>1.3</revnumber> |
| 56 | <date>October 2012</date> |
| 57 | <revremark>Released with the Yocto Project 1.3 Release.</revremark> |
| 58 | </revision> |
| 59 | <revision> |
| 60 | <revnumber>1.4</revnumber> |
| 61 | <date>April 2013</date> |
| 62 | <revremark>Released with the Yocto Project 1.4 Release.</revremark> |
| 63 | </revision> |
| 64 | <revision> |
| 65 | <revnumber>1.5</revnumber> |
| 66 | <date>October 2013</date> |
| 67 | <revremark>Released with the Yocto Project 1.5 Release.</revremark> |
| 68 | </revision> |
| 69 | <revision> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 70 | <revnumber>1.6</revnumber> |
| 71 | <date>April 2014</date> |
| 72 | <revremark>Released with the Yocto Project 1.6 Release.</revremark> |
| 73 | </revision> |
| 74 | <revision> |
| 75 | <revnumber>1.7</revnumber> |
| 76 | <date>October 2014</date> |
| 77 | <revremark>Released with the Yocto Project 1.7 Release.</revremark> |
| 78 | </revision> |
| 79 | <revision> |
| 80 | <revnumber>1.8</revnumber> |
| 81 | <date>April 2015</date> |
| 82 | <revremark>Released with the Yocto Project 1.8 Release.</revremark> |
| 83 | </revision> |
| 84 | <revision> |
Patrick Williams | f1e5d69 | 2016-03-30 15:21:19 -0500 | [diff] [blame] | 85 | <revnumber>2.0</revnumber> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 86 | <date>October 2015</date> |
Patrick Williams | f1e5d69 | 2016-03-30 15:21:19 -0500 | [diff] [blame] | 87 | <revremark>Released with the Yocto Project 2.0 Release.</revremark> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 88 | </revision> |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 89 | <revision> |
| 90 | <revnumber>2.1</revnumber> |
| 91 | <date>April 2016</date> |
| 92 | <revremark>Released with the Yocto Project 2.1 Release.</revremark> |
| 93 | </revision> |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 94 | <revision> |
| 95 | <revnumber>2.2</revnumber> |
| 96 | <date>October 2016</date> |
| 97 | <revremark>Released with the Yocto Project 2.2 Release.</revremark> |
| 98 | </revision> |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 99 | <revision> |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 100 | <revnumber>2.3</revnumber> |
| 101 | <date>May 2017</date> |
| 102 | <revremark>Released with the Yocto Project 2.3 Release.</revremark> |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 103 | </revision> |
| 104 | <revision> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 105 | <revnumber>2.4</revnumber> |
| 106 | <date>October 2017</date> |
| 107 | <revremark>Released with the Yocto Project 2.4 Release.</revremark> |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 108 | </revision> |
| 109 | <revision> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 110 | <revnumber>2.5</revnumber> |
| 111 | <date>May 2018</date> |
| 112 | <revremark>Released with the Yocto Project 2.5 Release.</revremark> |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 113 | </revision> |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 114 | <revision> |
Brad Bishop | 1a4b7ee | 2018-12-16 17:11:34 -0800 | [diff] [blame] | 115 | <revnumber>2.6</revnumber> |
| 116 | <date>November 2018</date> |
| 117 | <revremark>Released with the Yocto Project 2.6 Release.</revremark> |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 118 | </revision> |
Brad Bishop | f86d055 | 2018-12-04 14:18:15 -0800 | [diff] [blame] | 119 | <revision> |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 120 | <revnumber>2.7</revnumber> |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 121 | <date>May 2019</date> |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 122 | <revremark>Released with the Yocto Project 2.7 Release.</revremark> |
Brad Bishop | f86d055 | 2018-12-04 14:18:15 -0800 | [diff] [blame] | 123 | </revision> |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 124 | <revision> |
Brad Bishop | 64c979e | 2019-11-04 13:55:29 -0500 | [diff] [blame] | 125 | <revnumber>3.0</revnumber> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 126 | <date>October 2019</date> |
Brad Bishop | 64c979e | 2019-11-04 13:55:29 -0500 | [diff] [blame] | 127 | <revremark>Released with the Yocto Project 3.0 Release.</revremark> |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 128 | </revision> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 129 | <revision> |
| 130 | <revnumber>3.1</revnumber> |
| 131 | <date>&REL_MONTH_YEAR;</date> |
| 132 | <revremark>Released with the Yocto Project 3.1 Release.</revremark> |
| 133 | </revision> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 134 | </revhistory> |
| 135 | |
| 136 | <copyright> |
| 137 | <year>©RIGHT_YEAR;</year> |
| 138 | <holder>Linux Foundation</holder> |
| 139 | </copyright> |
| 140 | |
| 141 | <legalnotice> |
| 142 | <para> |
| 143 | Permission is granted to copy, distribute and/or modify this document under |
| 144 | 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 & Wales</ulink> as published by Creative Commons. |
| 145 | </para> |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 146 | <note><title>Manual Notes</title> |
| 147 | <itemizedlist> |
| 148 | <listitem><para> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 149 | This version of the |
| 150 | <emphasis>Yocto Project Reference Manual</emphasis> |
| 151 | is for the &YOCTO_DOC_VERSION; release of the |
| 152 | Yocto Project. |
| 153 | To be sure you have the latest version of the manual |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 154 | for this release, go to the |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 155 | <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 156 | and select the manual from that site. |
| 157 | Manuals from the site are more up-to-date than manuals |
| 158 | derived from the Yocto Project released TAR files. |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 159 | </para></listitem> |
| 160 | <listitem><para> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 161 | If you located this manual through a web search, the |
| 162 | version of the manual might not be the one you want |
| 163 | (e.g. the search might have returned a manual much |
| 164 | older than the Yocto Project version with which you |
| 165 | are working). |
| 166 | You can see all Yocto Project major releases by |
| 167 | visiting the |
| 168 | <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> |
| 169 | page. |
| 170 | If you need a version of this manual for a different |
| 171 | Yocto Project release, visit the |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 172 | <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 173 | and select the manual set by using the |
| 174 | "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" |
| 175 | pull-down menus. |
| 176 | </para></listitem> |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 177 | <listitem> |
| 178 | <para> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 179 | To report any inaccuracies or problems with this |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 180 | (or any other Yocto Project) manual, send an email to |
| 181 | the Yocto Project documentation mailing list at |
| 182 | <filename>docs@lists.yoctoproject.org</filename> or |
| 183 | log into the freenode <filename>#yocto</filename> channel. |
| 184 | </para> |
| 185 | </listitem> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 186 | </itemizedlist> |
| 187 | </note> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 188 | </legalnotice> |
| 189 | |
| 190 | </bookinfo> |
| 191 | |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 192 | <xi:include href="ref-system-requirements.xml"/> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 193 | |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 194 | <xi:include href="ref-terms.xml"/> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 195 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 196 | <xi:include href="ref-release-process.xml"/> |
| 197 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 198 | <xi:include href="migration.xml"/> |
| 199 | |
| 200 | <xi:include href="ref-structure.xml"/> |
| 201 | |
| 202 | <xi:include href="ref-classes.xml"/> |
| 203 | |
| 204 | <xi:include href="ref-tasks.xml"/> |
| 205 | |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 206 | <xi:include href="ref-devtool-reference.xml"/> |
| 207 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 208 | <xi:include href="ref-kickstart.xml"/> |
| 209 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 210 | <xi:include href="ref-qa-checks.xml"/> |
| 211 | |
| 212 | <xi:include href="ref-images.xml"/> |
| 213 | |
| 214 | <xi:include href="ref-features.xml"/> |
| 215 | |
| 216 | <xi:include href="ref-variables.xml"/> |
| 217 | |
| 218 | <xi:include href="ref-varlocality.xml"/> |
| 219 | |
| 220 | <xi:include href="faq.xml"/> |
| 221 | |
| 222 | <xi:include href="resources.xml"/> |
| 223 | |
| 224 | <!-- <index id='index'> |
| 225 | <title>Index</title> |
| 226 | </index> |
| 227 | --> |
| 228 | |
| 229 | </book> |
| 230 | <!-- |
| 231 | vim: expandtab tw=80 ts=4 |
| 232 | --> |