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> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 25 | <firstname>Scott</firstname> <surname>Rifenbark</surname> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 26 | <affiliation> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 27 | <orgname>Scotty's Documentation Services, INC</orgname> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 28 | </affiliation> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 29 | <email>srifenbark@gmail.com</email> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 30 | </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 Williams | f1e5d69 | 2016-03-30 15:21:19 -0500 | [diff] [blame] | 96 | <revnumber>2.0</revnumber> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 97 | <date>October 2015</date> |
Patrick Williams | f1e5d69 | 2016-03-30 15:21:19 -0500 | [diff] [blame] | 98 | <revremark>Released with the Yocto Project 2.0 Release.</revremark> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 99 | </revision> |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 100 | <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 Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 105 | <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 Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 110 | <revision> |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 111 | <revnumber>2.3</revnumber> |
| 112 | <date>May 2017</date> |
| 113 | <revremark>Released with the Yocto Project 2.3 Release.</revremark> |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 114 | </revision> |
| 115 | <revision> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 116 | <revnumber>2.4</revnumber> |
| 117 | <date>October 2017</date> |
| 118 | <revremark>Released with the Yocto Project 2.4 Release.</revremark> |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 119 | </revision> |
| 120 | <revision> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 121 | <revnumber>2.5</revnumber> |
| 122 | <date>May 2018</date> |
| 123 | <revremark>Released with the Yocto Project 2.5 Release.</revremark> |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 124 | </revision> |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 125 | <revision> |
| 126 | <revnumber>2.5.1</revnumber> |
| 127 | <date>September 2018</date> |
| 128 | <revremark>The initial document released with the Yocto Project 2.5.1 Release.</revremark> |
| 129 | </revision> |
Brad Bishop | f86d055 | 2018-12-04 14:18:15 -0800 | [diff] [blame^] | 130 | <revision> |
| 131 | <revnumber>2.5.2</revnumber> |
| 132 | <date>&REL_MONTH_YEAR;</date> |
| 133 | <revremark>The initial document released with the Yocto Project 2.5.2 Release.</revremark> |
| 134 | </revision> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 135 | </revhistory> |
| 136 | |
| 137 | <copyright> |
| 138 | <year>©RIGHT_YEAR;</year> |
| 139 | <holder>Linux Foundation</holder> |
| 140 | </copyright> |
| 141 | |
| 142 | <legalnotice> |
| 143 | <para> |
| 144 | Permission is granted to copy, distribute and/or modify this document under |
| 145 | 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. |
| 146 | </para> |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 147 | <note><title>Manual Notes</title> |
| 148 | <itemizedlist> |
| 149 | <listitem><para> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 150 | This version of the |
| 151 | <emphasis>Yocto Project Reference Manual</emphasis> |
| 152 | is for the &YOCTO_DOC_VERSION; release of the |
| 153 | Yocto Project. |
| 154 | To be sure you have the latest version of the manual |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 155 | for this release, go to the |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 156 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 157 | and select the manual from that site. |
| 158 | Manuals from the site are more up-to-date than manuals |
| 159 | derived from the Yocto Project released TAR files. |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 160 | </para></listitem> |
| 161 | <listitem><para> |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 162 | If you located this manual through a web search, the |
| 163 | version of the manual might not be the one you want |
| 164 | (e.g. the search might have returned a manual much |
| 165 | older than the Yocto Project version with which you |
| 166 | are working). |
| 167 | You can see all Yocto Project major releases by |
| 168 | visiting the |
| 169 | <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> |
| 170 | page. |
| 171 | If you need a version of this manual for a different |
| 172 | Yocto Project release, visit the |
| 173 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> |
| 174 | and select the manual set by using the |
| 175 | "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" |
| 176 | pull-down menus. |
| 177 | </para></listitem> |
| 178 | <listitem><para> |
| 179 | To report any inaccuracies or problems with this |
| 180 | manual, send an email to the Yocto Project |
| 181 | discussion group at |
| 182 | <filename>yocto@yoctoproject.com</filename> or log into |
| 183 | the freenode <filename>#yocto</filename> channel. |
| 184 | </para></listitem> |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 185 | </itemizedlist> |
| 186 | </note> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 187 | </legalnotice> |
| 188 | |
| 189 | </bookinfo> |
| 190 | |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 191 | <xi:include href="ref-system-requirements.xml"/> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 192 | |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 193 | <xi:include href="ref-terms.xml"/> |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 194 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 195 | <xi:include href="ref-release-process.xml"/> |
| 196 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 197 | <xi:include href="migration.xml"/> |
| 198 | |
| 199 | <xi:include href="ref-structure.xml"/> |
| 200 | |
| 201 | <xi:include href="ref-classes.xml"/> |
| 202 | |
| 203 | <xi:include href="ref-tasks.xml"/> |
| 204 | |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 205 | <xi:include href="ref-devtool-reference.xml"/> |
| 206 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 207 | <xi:include href="ref-kickstart.xml"/> |
| 208 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 209 | <xi:include href="ref-qa-checks.xml"/> |
| 210 | |
| 211 | <xi:include href="ref-images.xml"/> |
| 212 | |
| 213 | <xi:include href="ref-features.xml"/> |
| 214 | |
| 215 | <xi:include href="ref-variables.xml"/> |
| 216 | |
| 217 | <xi:include href="ref-varlocality.xml"/> |
| 218 | |
| 219 | <xi:include href="faq.xml"/> |
| 220 | |
| 221 | <xi:include href="resources.xml"/> |
| 222 | |
| 223 | <!-- <index id='index'> |
| 224 | <title>Index</title> |
| 225 | </index> |
| 226 | --> |
| 227 | |
| 228 | </book> |
| 229 | <!-- |
| 230 | vim: expandtab tw=80 ts=4 |
| 231 | --> |