Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [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 | <!--SPDX-License-Identifier: CC-BY-2.0-UK--> |
| 5 | |
| 6 | <book id='mega-manual' lang='en' |
| 7 | xmlns:xi="http://www.w3.org/2003/XInclude" |
| 8 | xmlns="http://docbook.org/ns/docbook" |
| 9 | > |
| 10 | |
| 11 | <bookinfo> |
| 12 | |
| 13 | <abstract> |
| 14 | The Yocto Project Mega-Manual is a concatenation of the published |
| 15 | Yocto Project HTML manuals along with the corresponding BitBake |
| 16 | User Manual for the given release. |
| 17 | The Mega-Manual exists to help users efficiently search for strings |
| 18 | across the entire Yocto Project documentation set inclusive of |
| 19 | the BitBake User Manual. |
| 20 | </abstract> |
| 21 | |
| 22 | <mediaobject> |
| 23 | <imageobject> |
| 24 | <imagedata fileref='figures/mega-title.png' |
| 25 | format='SVG' |
| 26 | align='left' scalefit='1' width='100%'/> |
| 27 | </imageobject> |
| 28 | </mediaobject> |
| 29 | |
| 30 | <title> |
| 31 | Yocto Project Mega-Manual |
| 32 | </title> |
| 33 | |
| 34 | <authorgroup> |
| 35 | <author> |
| 36 | <affiliation> |
| 37 | <orgname>&ORGNAME;</orgname> |
| 38 | </affiliation> |
| 39 | <email>&ORGEMAIL;</email> |
| 40 | </author> |
| 41 | </authorgroup> |
| 42 | |
| 43 | <revhistory> |
| 44 | <revision> |
| 45 | <revnumber>1.8</revnumber> |
| 46 | <date>April 2015</date> |
| 47 | <revremark>The initial document released with the Yocto Project 1.8 Release.</revremark> |
| 48 | </revision> |
| 49 | <revision> |
| 50 | <revnumber>2.0</revnumber> |
| 51 | <date>October 2015</date> |
| 52 | <revremark>Released with the Yocto Project 2.0 Release.</revremark> |
| 53 | </revision> |
| 54 | <revision> |
| 55 | <revnumber>2.1</revnumber> |
| 56 | <date>April 2016</date> |
| 57 | <revremark>Released with the Yocto Project 2.1 Release.</revremark> |
| 58 | </revision> |
| 59 | <revision> |
| 60 | <revnumber>2.2</revnumber> |
| 61 | <date>October 2016</date> |
| 62 | <revremark>Released with the Yocto Project 2.2 Release.</revremark> |
| 63 | </revision> |
| 64 | <revision> |
| 65 | <revnumber>2.3</revnumber> |
| 66 | <date>May 2017</date> |
| 67 | <revremark>Released with the Yocto Project 2.3 Release.</revremark> |
| 68 | </revision> |
| 69 | <revision> |
| 70 | <revnumber>2.4</revnumber> |
| 71 | <date>October 2017</date> |
| 72 | <revremark>Released with the Yocto Project 2.4 Release.</revremark> |
| 73 | </revision> |
| 74 | <revision> |
| 75 | <revnumber>2.5</revnumber> |
| 76 | <date>May 2018</date> |
| 77 | <revremark>Released with the Yocto Project 2.5 Release.</revremark> |
| 78 | </revision> |
| 79 | <revision> |
| 80 | <revnumber>2.6</revnumber> |
| 81 | <date>November 2018</date> |
| 82 | <revremark>Released with the Yocto Project 2.6 Release.</revremark> |
| 83 | </revision> |
| 84 | <revision> |
| 85 | <revnumber>2.7</revnumber> |
| 86 | <date>May 2019</date> |
| 87 | <revremark>Released with the Yocto Project 2.7 Release.</revremark> |
| 88 | </revision> |
| 89 | <revision> |
| 90 | <revnumber>3.0</revnumber> |
| 91 | <date>October 2019</date> |
| 92 | <revremark>Released with the Yocto Project 3.0 Release.</revremark> |
| 93 | </revision> |
| 94 | <revision> |
| 95 | <revnumber>3.1</revnumber> |
| 96 | <date>&REL_MONTH_YEAR;</date> |
| 97 | <revremark>Released with the Yocto Project 3.1 Release.</revremark> |
| 98 | </revision> |
| 99 | </revhistory> |
| 100 | |
| 101 | <copyright> |
| 102 | <year>©RIGHT_YEAR;</year> |
| 103 | <holder>Linux Foundation</holder> |
| 104 | </copyright> |
| 105 | |
| 106 | <legalnotice> |
| 107 | <para> |
| 108 | Permission is granted to copy, distribute and/or modify this document under |
| 109 | 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. |
| 110 | </para> |
| 111 | <note><title>Manual Notes</title> |
| 112 | <itemizedlist> |
| 113 | <listitem><para> |
| 114 | This version of the |
| 115 | <emphasis>Yocto Project Mega-Manual</emphasis> |
| 116 | is for the &YOCTO_DOC_VERSION; release of the |
| 117 | Yocto Project. |
| 118 | To be sure you have the latest version of the manual |
| 119 | for this release, go to the |
| 120 | <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> |
| 121 | and select the manual from that site. |
| 122 | Manuals from the site are more up-to-date than manuals |
| 123 | derived from the Yocto Project released TAR files. |
| 124 | </para></listitem> |
| 125 | <listitem><para> |
| 126 | If you located this manual through a web search, the |
| 127 | version of the manual might not be the one you want |
| 128 | (e.g. the search might have returned a manual much |
| 129 | older than the Yocto Project version with which you |
| 130 | are working). |
| 131 | You can see all Yocto Project major releases by |
| 132 | visiting the |
| 133 | <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> |
| 134 | page. |
| 135 | If you need a version of this manual for a different |
| 136 | Yocto Project release, visit the |
| 137 | <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> |
| 138 | and select the manual set by using the |
| 139 | "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" |
| 140 | pull-down menus. |
| 141 | </para></listitem> |
| 142 | <listitem> |
| 143 | <para> |
| 144 | To report any inaccuracies or problems with this |
| 145 | (or any other Yocto Project) manual, send an email to |
| 146 | the Yocto Project documentation mailing list at |
| 147 | <filename>docs@lists.yoctoproject.org</filename> or |
| 148 | log into the freenode <filename>#yocto</filename> channel. |
| 149 | </para> |
| 150 | </listitem> |
| 151 | </itemizedlist> |
| 152 | </note> |
| 153 | |
| 154 | </legalnotice> |
| 155 | |
| 156 | </bookinfo> |
| 157 | |
| 158 | <!-- Includes brief-yoctoprojectqs --> |
| 159 | |
| 160 | <para> |
| 161 | <imagedata fileref="figures/bypqs-title.png" width="100%" align="left" scalefit="1" /> |
| 162 | </para> |
| 163 | |
| 164 | <xi:include |
| 165 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../brief-yoctoprojectqs/brief-yoctoprojectqs.xml"/> |
| 166 | |
| 167 | <!-- Includes overview-manual title image and then overview-manual chapters --> |
| 168 | |
| 169 | <para> |
| 170 | <imagedata fileref="figures/overview-manual-title.png" width="100%" align="left" scalefit="1" /> |
| 171 | </para> |
| 172 | |
| 173 | <xi:include |
| 174 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-intro.xml"/> |
| 175 | |
| 176 | <xi:include |
| 177 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-yp-intro.xml"/> |
| 178 | |
| 179 | <xi:include |
| 180 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-development-environment.xml"/> |
| 181 | |
| 182 | <xi:include |
| 183 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-concepts.xml"/> |
| 184 | |
| 185 | <!-- Includes dev-manual title image and then dev-manual chapters --> |
| 186 | |
| 187 | <para> |
| 188 | <imagedata fileref="figures/dev-title.png" width="100%" align="left" scalefit="1" /> |
| 189 | </para> |
| 190 | |
| 191 | <xi:include |
| 192 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-intro.xml"/> |
| 193 | <xi:include |
| 194 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-start.xml"/> |
| 195 | <xi:include |
| 196 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-common-tasks.xml"/> |
| 197 | <xi:include |
| 198 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-qemu.xml"/> |
| 199 | |
| 200 | <!-- Includes sdk-manual title image and then sdk-manual chapters --> |
| 201 | |
| 202 | <para> |
| 203 | <imagedata fileref="figures/sdk-title.png" width="100%" align="left" scalefit="1" /> |
| 204 | </para> |
| 205 | |
| 206 | <xi:include |
| 207 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-intro.xml"/> |
| 208 | <xi:include |
| 209 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-extensible.xml"/> |
| 210 | <xi:include |
| 211 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-using.xml"/> |
| 212 | <xi:include |
| 213 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-working-projects.xml"/> |
| 214 | <xi:include |
| 215 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-obtain.xml"/> |
| 216 | <xi:include |
| 217 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/> |
| 218 | <xi:include |
| 219 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/> |
| 220 | |
| 221 | <!-- Includes bsp-guide title image and then bsp-guide chapters --> |
| 222 | |
| 223 | <para> |
| 224 | <imagedata fileref="figures/bsp-title.png" width="100%" align="left" scalefit="1" /> |
| 225 | </para> |
| 226 | |
| 227 | <xi:include |
| 228 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../bsp-guide/bsp.xml"/> |
| 229 | |
| 230 | <!-- Includes kernel-dev title image and then kernel-dev chapters --> |
| 231 | |
| 232 | <para> |
| 233 | <imagedata fileref="figures/kernel-dev-title.png" width="100%" align="left" scalefit="1" /> |
| 234 | </para> |
| 235 | |
| 236 | <xi:include |
| 237 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-intro.xml"/> |
| 238 | <xi:include |
| 239 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-common.xml"/> |
| 240 | <xi:include |
| 241 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-advanced.xml"/> |
| 242 | <xi:include |
| 243 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-concepts-appx.xml"/> |
| 244 | <xi:include |
| 245 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-maint-appx.xml"/> |
| 246 | |
| 247 | <!-- Includes profile-manual title image and then profile-manual chapters --> |
| 248 | |
| 249 | <para> |
| 250 | <imagedata fileref="figures/profile-title.png" width="100%" align="left" scalefit="1" /> |
| 251 | </para> |
| 252 | |
| 253 | <xi:include |
| 254 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-intro.xml"/> |
| 255 | <xi:include |
| 256 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-arch.xml"/> |
| 257 | <xi:include |
| 258 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-usage.xml"/> |
| 259 | <xi:include |
| 260 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-examples.xml"/> |
| 261 | |
| 262 | <!-- Includes ref-manual title image and then ref-manual chapters --> |
| 263 | |
| 264 | <para> |
| 265 | <imagedata fileref="figures/poky-title.png" width="100%" align="left" scalefit="1" /> |
| 266 | </para> |
| 267 | |
| 268 | <xi:include |
| 269 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-system-requirements.xml"/> |
| 270 | |
| 271 | <xi:include |
| 272 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-terms.xml"/> |
| 273 | |
| 274 | <xi:include |
| 275 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-release-process.xml"/> |
| 276 | |
| 277 | <xi:include |
| 278 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/migration.xml"/> |
| 279 | |
| 280 | <xi:include |
| 281 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-structure.xml"/> |
| 282 | |
| 283 | <xi:include |
| 284 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-classes.xml"/> |
| 285 | |
| 286 | <xi:include |
| 287 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-tasks.xml"/> |
| 288 | |
| 289 | <xi:include |
| 290 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/> |
| 291 | |
| 292 | <xi:include |
| 293 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-kickstart.xml"/> |
| 294 | |
| 295 | <xi:include |
| 296 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/> |
| 297 | |
| 298 | <xi:include |
| 299 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-images.xml"/> |
| 300 | |
| 301 | <xi:include |
| 302 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-features.xml"/> |
| 303 | |
| 304 | <xi:include |
| 305 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-variables.xml"/> |
| 306 | |
| 307 | <xi:include |
| 308 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-varlocality.xml"/> |
| 309 | |
| 310 | <xi:include |
| 311 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/faq.xml"/> |
| 312 | |
| 313 | <xi:include |
| 314 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/resources.xml"/> |
| 315 | |
| 316 | <!-- Includes toaster-manual title image and then toaster-manual chapters --> |
| 317 | |
| 318 | <para> |
| 319 | <imagedata fileref="figures/toaster-title.png" width="100%" align="left" scalefit="1" /> |
| 320 | </para> |
| 321 | |
| 322 | <xi:include |
| 323 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-intro.xml"/> |
| 324 | |
| 325 | <xi:include |
| 326 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-start.xml"/> |
| 327 | |
| 328 | <xi:include |
| 329 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-setup-and-use.xml"/> |
| 330 | |
| 331 | <xi:include |
| 332 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/> |
| 333 | |
| 334 | <!-- Includes bitbake-user-manual title image and then bitbake-user-manual chapters --> |
| 335 | |
| 336 | <para> |
| 337 | <imagedata fileref="figures/bitbake-title.png" width="100%" align="left" scalefit="1" /> |
| 338 | </para> |
| 339 | |
| 340 | <xi:include |
| 341 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml"/> |
| 342 | |
| 343 | <xi:include |
| 344 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml"/> |
| 345 | |
| 346 | <xi:include |
| 347 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml"/> |
| 348 | |
| 349 | <xi:include |
| 350 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml"/> |
| 351 | |
| 352 | <xi:include |
| 353 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml"/> |
| 354 | |
| 355 | <xi:include |
| 356 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml"/> |
| 357 | |
| 358 | </book> |
| 359 | |
| 360 | <!-- |
| 361 | vim: expandtab tw=80 ts=4 |
| 362 | --> |