diff options
Diffstat (limited to 'poky/documentation/mega-manual/mega-manual.xml')
-rwxr-xr-x | poky/documentation/mega-manual/mega-manual.xml | 362 |
1 files changed, 362 insertions, 0 deletions
diff --git a/poky/documentation/mega-manual/mega-manual.xml b/poky/documentation/mega-manual/mega-manual.xml new file mode 100755 index 000000000..d9912fa44 --- /dev/null +++ b/poky/documentation/mega-manual/mega-manual.xml @@ -0,0 +1,362 @@ +<!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; ] > +<!--SPDX-License-Identifier: CC-BY-2.0-UK--> + +<book id='mega-manual' lang='en' + xmlns:xi="http://www.w3.org/2003/XInclude" + xmlns="http://docbook.org/ns/docbook" + > + + <bookinfo> + + <abstract> + The Yocto Project Mega-Manual is a concatenation of the published + Yocto Project HTML manuals along with the corresponding BitBake + User Manual for the given release. + The Mega-Manual exists to help users efficiently search for strings + across the entire Yocto Project documentation set inclusive of + the BitBake User Manual. + </abstract> + + <mediaobject> + <imageobject> + <imagedata fileref='figures/mega-title.png' + format='SVG' + align='left' scalefit='1' width='100%'/> + </imageobject> + </mediaobject> + + <title> + Yocto Project Mega-Manual + </title> + + <authorgroup> + <author> + <affiliation> + <orgname>&ORGNAME;</orgname> + </affiliation> + <email>&ORGEMAIL;</email> + </author> + </authorgroup> + + <revhistory> + <revision> + <revnumber>1.8</revnumber> + <date>April 2015</date> + <revremark>The initial document 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> + <revision> + <revnumber>2.5</revnumber> + <date>May 2018</date> + <revremark>Released with the Yocto Project 2.5 Release.</revremark> + </revision> + <revision> + <revnumber>2.6</revnumber> + <date>November 2018</date> + <revremark>Released with the Yocto Project 2.6 Release.</revremark> + </revision> + <revision> + <revnumber>2.7</revnumber> + <date>May 2019</date> + <revremark>Released with the Yocto Project 2.7 Release.</revremark> + </revision> + <revision> + <revnumber>3.0</revnumber> + <date>October 2019</date> + <revremark>Released with the Yocto Project 3.0 Release.</revremark> + </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> + </revhistory> + + <copyright> + <year>©RIGHT_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 & Wales</ulink> as published by Creative Commons. + </para> + <note><title>Manual Notes</title> + <itemizedlist> + <listitem><para> + This version of the + <emphasis>Yocto Project Mega-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, go to the + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> + and select the manual from that site. + Manuals from the site are more up-to-date than manuals + derived from the Yocto Project released TAR files. + </para></listitem> + <listitem><para> + If you located this manual through a web search, the + version of the manual might not be the one you want + (e.g. the search might have returned a manual much + older than the Yocto Project version with which you + are working). + You can see all Yocto Project major releases by + visiting the + <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> + page. + If you need a version of this manual for a different + Yocto Project release, visit the + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> + and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" + pull-down menus. + </para></listitem> + <listitem> + <para> + To report any inaccuracies or problems with this + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> + </itemizedlist> + </note> + + </legalnotice> + + </bookinfo> + +<!-- Includes brief-yoctoprojectqs --> + + <para> + <imagedata fileref="figures/bypqs-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../brief-yoctoprojectqs/brief-yoctoprojectqs.xml"/> + +<!-- Includes overview-manual title image and then overview-manual chapters --> + + <para> + <imagedata fileref="figures/overview-manual-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-intro.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-yp-intro.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-development-environment.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-concepts.xml"/> + +<!-- Includes dev-manual title image and then dev-manual chapters --> + + <para> + <imagedata fileref="figures/dev-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-intro.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-start.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-common-tasks.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual-qemu.xml"/> + +<!-- Includes sdk-manual title image and then sdk-manual chapters --> + + <para> + <imagedata fileref="figures/sdk-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-intro.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-extensible.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-using.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-working-projects.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-obtain.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/> + +<!-- Includes bsp-guide title image and then bsp-guide chapters --> + + <para> + <imagedata fileref="figures/bsp-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../bsp-guide/bsp.xml"/> + +<!-- Includes kernel-dev title image and then kernel-dev chapters --> + + <para> + <imagedata fileref="figures/kernel-dev-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-intro.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-common.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-advanced.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-concepts-appx.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev-maint-appx.xml"/> + +<!-- Includes profile-manual title image and then profile-manual chapters --> + + <para> + <imagedata fileref="figures/profile-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-intro.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-arch.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-usage.xml"/> + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual-examples.xml"/> + +<!-- Includes ref-manual title image and then ref-manual chapters --> + + <para> + <imagedata fileref="figures/poky-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-system-requirements.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-terms.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-release-process.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/migration.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-structure.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-classes.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-tasks.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-kickstart.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-images.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-features.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-variables.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-varlocality.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/faq.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/resources.xml"/> + +<!-- Includes toaster-manual title image and then toaster-manual chapters --> + + <para> + <imagedata fileref="figures/toaster-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-intro.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-start.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-setup-and-use.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../toaster-manual/toaster-manual-reference.xml"/> + +<!-- Includes bitbake-user-manual title image and then bitbake-user-manual chapters --> + + <para> + <imagedata fileref="figures/bitbake-title.png" width="100%" align="left" scalefit="1" /> + </para> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml"/> + + <xi:include + xmlns:xi="http://www.w3.org/2003/XInclude" href="../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml"/> + +</book> + +<!-- +vim: expandtab tw=80 ts=4 +--> |