diff options
43 files changed, 312 insertions, 290 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index c6584af546..bb7f327598 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -88,6 +88,12 @@ ifeq ($(DOC),overview-manual) XSLTOPTS = --xinclude ALLPREQ = html eclipse tarball TARFILES = overview-style.css overview-manual.html figures/overview-title.png \ + figures/git-workflow.png figures/source-repos.png figures/index-downloads.png \ + figures/yp-download.png figures/yocto-environment-ref.png figures/user-configuration.png \ + figures/layer-input.png figures/source-input.png figures/package-feeds.png \ + figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ + figures/analysis-for-package-splitting.png figures/image-generation.png \ + figures/sdk-generation.png figures/images.png figures/sdk.png \ eclipse MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse FIGURES = figures @@ -274,16 +280,11 @@ ifeq ($(DOC),ref-manual) XSLTOPTS = --xinclude ALLPREQ = html eclipse tarball TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \ - figures/buildhistory.png figures/buildhistory-web.png eclipse \ - figures/cross-development-toolchains.png figures/layer-input.png \ - figures/package-feeds.png figures/source-input.png \ - figures/user-configuration.png figures/yocto-environment-ref.png \ - figures/images.png figures/sdk.png figures/source-fetching.png \ - figures/patching.png figures/configuration-compile-autoreconf.png \ - figures/analysis-for-package-splitting.png figures/image-generation.png \ - figures/sdk-generation.png figures/building-an-image.png \ - figures/build-workspace-directory.png figures/source-repos.png \ - figures/index-downloads.png figures/yp-download.png figures/git-workflow.png + figures/buildhistory.png figures/buildhistory-web.png \ + figures/cross-development-toolchains.png \ + figures/building-an-image.png \ + figures/build-workspace-directory.png \ + eclipse MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse FIGURES = figures STYLESHEET = $(DOC)/*.css diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 6f2aa384b2..6ae3ff9804 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -55,7 +55,7 @@ To help understand the BSP layer concept, consider the BSPs that the Yocto Project supports and provides with each release. You can see the layers in the - <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> through a web interface at <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. If you go to that interface, you will find near the bottom of the list @@ -1486,7 +1486,7 @@ <para> Designed to have a command interface somewhat like - <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>, each + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>, each tool is structured as a set of sub-commands under a top-level command. The top-level command (<filename>yocto-bsp</filename> diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index dd74e7cd65..f04846ae36 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1507,8 +1507,8 @@ </itemizedlist> <note> For information on recipe syntax, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#recipe-syntax'>Recipe Syntax</ulink>" - section in the Yocto Project Reference Manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#recipe-syntax'>Recipe Syntax</ulink>" + section in the Yocto Project Overview Manual. </note> </para> @@ -1798,8 +1798,8 @@ <para> You can find more information about the build process in - "<ulink url='&YOCTO_DOCS_REF_URL;#ref-development-environment'>The Yocto Project Development Environment</ulink>" - chapter of the Yocto Project Reference Manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" + chapter of the Yocto Project Overview Manual. </para> </section> @@ -1815,8 +1815,8 @@ Your recipe must have a <filename>SRC_URI</filename> variable that points to where the source is located. For a graphical representation of source locations, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#sources-dev-environment'>Sources</ulink>" - section in the Yocto Project Reference Manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sources-dev-environment'>Sources</ulink>" + section in the Yocto Project Overview Manual. </para> <para> @@ -5183,7 +5183,7 @@ can use an existing file provided by the Wic installation. As shipped, kickstart files can be found in the Yocto Project - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> in the following two locations: <literallayout class='monospaced'> poky/meta-yocto-bsp/wic @@ -7458,7 +7458,7 @@ Some notes from Cal: <filename>connman.inc</filename> file in the <filename>meta/recipes-connectivity/connman/</filename> directory of the <filename>poky</filename> - <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>source repository</ulink>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>source repository</ulink>. You can also find examples in <filename>meta/classes/kernel.bbclass</filename>. </para> diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index a0fbb4bfd1..638d9112c7 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -99,7 +99,7 @@ with the OpenEmbedded build system is advisable. Of the SCMs BitBake supports, the Yocto Project team strongly recommends using - <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>. Git is a distributed system that is easy to backup, allows you to work remotely, and then connects back to the infrastructure. @@ -310,7 +310,8 @@ Consider the following: <itemizedlist> <listitem><para> - Use <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> + Use + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> as the source control system. </para></listitem> <listitem><para> @@ -324,7 +325,7 @@ Separate the project's Metadata and code by using separate Git repositories. See the - "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" section for information on these repositories. See the "<link linkend='working-with-yocto-project-source-files'>Working With Yocto Project Source Files</link>" @@ -548,8 +549,8 @@ pull the change into the component's upstream repository. You do this by pushing to a contribution repository that is upstream. See the - "<ulink url='&YOCTO_DOCS_REF_URL;#workflows'>Workflows</ulink>" - section in the Yocto Project Reference Manual for additional + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#workflows'>Workflows</ulink>" + section in the Yocto Project Overview Manual for additional concepts on working in the Yocto Project development environment. </para> @@ -748,7 +749,7 @@ </para></listitem> <listitem><para> <emphasis>Search by File:</emphasis> - Using <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>, + Using <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>, you can enter the following command to bring up a short list of all commits against a specific file: <literallayout class='monospaced'> diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index ff8b56e62b..64d048d240 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -262,13 +262,13 @@ <listitem><para> For concepts and introductory information about Git as it is used in the Yocto Project, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>" - section in the Yocto Project Reference Manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>" + section in the Yocto Project Overview Manual. </para></listitem> <listitem><para> For concepts on Yocto Project source repositories, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" - section in the Yocto Project Reference Manual." + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" + section in the Yocto Project Overview Manual." </para></listitem> </itemizedlist> </note> @@ -279,7 +279,7 @@ <para> Working from a copy of the upstream Yocto Project - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> is the preferred method for obtaining and using a Yocto Project release. You can view the Yocto Project Source Repositories at @@ -308,7 +308,7 @@ <listitem><para> <emphasis>Find the URL Used to Clone the Repository:</emphasis> At the bottom of the page, note the URL used to - <ulink url='&YOCTO_DOCS_REF_URL;#git-commands-clone'>clone</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git-commands-clone'>clone</ulink> that repository (e.g. <filename>&YOCTO_GIT_URL;/poky</filename>). <note> @@ -468,7 +468,7 @@ <para> You create your Source Directory by using - <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> to clone a local + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> to clone a local copy of the upstream <filename>poky</filename> repository. <note><title>Tip</title> The preferred method of getting the Yocto Project Source @@ -734,8 +734,8 @@ <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> under <filename>tmp/deploy/images</filename>. For detailed information on the build process using BitBake, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#images-dev-environment'>Images</ulink>" - section in the Yocto Project Reference Manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" + section in the Yocto Project Overview Manual. You can also reference the "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" section in the Yocto Project Quick Start. diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index c3013b8f76..11ab37ffaf 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml @@ -21,7 +21,7 @@ <para> Kernel Metadata exists in many places. One area in the Yocto Project - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> is the <filename>yocto-kernel-cache</filename> Git repository. You can find this repository grouped under the "Yocto Linux Kernel" heading in the diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index b8fd870162..5b392a144c 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -79,7 +79,7 @@ </literallayout> <note> The previous commands assume the - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> (i.e. <filename>poky</filename>) have been cloned using Git and the local repository is named "poky". @@ -303,7 +303,7 @@ </literallayout> <note> The previous commands assume the - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> (i.e. <filename>poky</filename>) have been cloned using Git and the local repository is named "poky". diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.xml b/documentation/kernel-dev/kernel-dev-concepts-appx.xml index fbecc13875..231ef9a43d 100644 --- a/documentation/kernel-dev/kernel-dev-concepts-appx.xml +++ b/documentation/kernel-dev/kernel-dev-concepts-appx.xml @@ -49,7 +49,7 @@ <para> You can find a web interface to the Yocto Linux kernels in the - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> at <ulink url='&YOCTO_GIT_URL;'></ulink>. If you look at the interface, you will see to the left a @@ -239,8 +239,8 @@ <ulink url='http://git-scm.com/documentation'></ulink>. You can also get an introduction to Git as it applies to the Yocto Project in the - "<ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>" - section in the Yocto Project Reference Manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>" + section in the Yocto Project Overview Manual. The latter reference provides an overview of Git and presents a minimal set of Git commands that allows you to be functional using Git. @@ -381,7 +381,7 @@ generic kernel just for conceptual purposes. Also keep in mind that this structure represents the Yocto Project - <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> that are either pulled from during the build or established on the host development system prior to the build by either cloning a particular kernel's Git repository or by diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index 22b3a86a4d..68fb1e17d8 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml @@ -138,6 +138,9 @@ <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-development-environment.xml"/> + <!-- Includes dev-manual title image and then dev-manual chapters --> <para> @@ -234,9 +237,6 @@ xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/usingpoky.xml"/> <xi:include - xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-development-environment.xml"/> - - <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/technical-details.xml"/> <xi:include diff --git a/documentation/ref-manual/figures/analysis-for-package-splitting.png b/documentation/overview-manual/figures/analysis-for-package-splitting.png Binary files differindex 04f2794ea9..04f2794ea9 100644 --- a/documentation/ref-manual/figures/analysis-for-package-splitting.png +++ b/documentation/overview-manual/figures/analysis-for-package-splitting.png diff --git a/documentation/ref-manual/figures/configuration-compile-autoreconf.png b/documentation/overview-manual/figures/configuration-compile-autoreconf.png Binary files differindex a07464f04c..a07464f04c 100644 --- a/documentation/ref-manual/figures/configuration-compile-autoreconf.png +++ b/documentation/overview-manual/figures/configuration-compile-autoreconf.png diff --git a/documentation/ref-manual/figures/git-workflow.png b/documentation/overview-manual/figures/git-workflow.png Binary files differindex e401330a12..e401330a12 100644 --- a/documentation/ref-manual/figures/git-workflow.png +++ b/documentation/overview-manual/figures/git-workflow.png diff --git a/documentation/ref-manual/figures/image-generation.png b/documentation/overview-manual/figures/image-generation.png Binary files differindex 71a48dc6f4..71a48dc6f4 100644 --- a/documentation/ref-manual/figures/image-generation.png +++ b/documentation/overview-manual/figures/image-generation.png diff --git a/documentation/ref-manual/figures/images.png b/documentation/overview-manual/figures/images.png Binary files differindex d99eac1fbf..d99eac1fbf 100644 --- a/documentation/ref-manual/figures/images.png +++ b/documentation/overview-manual/figures/images.png diff --git a/documentation/ref-manual/figures/index-downloads.png b/documentation/overview-manual/figures/index-downloads.png Binary files differindex 96303b8781..96303b8781 100644 --- a/documentation/ref-manual/figures/index-downloads.png +++ b/documentation/overview-manual/figures/index-downloads.png diff --git a/documentation/ref-manual/figures/layer-input.png b/documentation/overview-manual/figures/layer-input.png Binary files differindex 0a4f2e74f3..0a4f2e74f3 100644 --- a/documentation/ref-manual/figures/layer-input.png +++ b/documentation/overview-manual/figures/layer-input.png diff --git a/documentation/ref-manual/figures/package-feeds.png b/documentation/overview-manual/figures/package-feeds.png Binary files differindex 37c9c32506..37c9c32506 100644 --- a/documentation/ref-manual/figures/package-feeds.png +++ b/documentation/overview-manual/figures/package-feeds.png diff --git a/documentation/ref-manual/figures/patching.png b/documentation/overview-manual/figures/patching.png Binary files differindex 8ecd018502..8ecd018502 100644 --- a/documentation/ref-manual/figures/patching.png +++ b/documentation/overview-manual/figures/patching.png diff --git a/documentation/ref-manual/figures/sdk-generation.png b/documentation/overview-manual/figures/sdk-generation.png Binary files differindex adbe1f4acf..adbe1f4acf 100755 --- a/documentation/ref-manual/figures/sdk-generation.png +++ b/documentation/overview-manual/figures/sdk-generation.png diff --git a/documentation/ref-manual/figures/sdk.png b/documentation/overview-manual/figures/sdk.png Binary files differindex 5c36b7548b..5c36b7548b 100644 --- a/documentation/ref-manual/figures/sdk.png +++ b/documentation/overview-manual/figures/sdk.png diff --git a/documentation/ref-manual/figures/source-fetching.png b/documentation/overview-manual/figures/source-fetching.png Binary files differindex 26aefb50c2..26aefb50c2 100644 --- a/documentation/ref-manual/figures/source-fetching.png +++ b/documentation/overview-manual/figures/source-fetching.png diff --git a/documentation/ref-manual/figures/source-input.png b/documentation/overview-manual/figures/source-input.png Binary files differindex f7515058ef..f7515058ef 100644 --- a/documentation/ref-manual/figures/source-input.png +++ b/documentation/overview-manual/figures/source-input.png diff --git a/documentation/overview-manual/figures/source-repos.png b/documentation/overview-manual/figures/source-repos.png Binary files differnew file mode 100644 index 0000000000..603300b6d2 --- /dev/null +++ b/documentation/overview-manual/figures/source-repos.png diff --git a/documentation/ref-manual/figures/user-configuration.png b/documentation/overview-manual/figures/user-configuration.png Binary files differindex c298401fc3..c298401fc3 100755..100644 --- a/documentation/ref-manual/figures/user-configuration.png +++ b/documentation/overview-manual/figures/user-configuration.png diff --git a/documentation/ref-manual/figures/yocto-environment-ref.png b/documentation/overview-manual/figures/yocto-environment-ref.png Binary files differindex 650c6c8030..650c6c8030 100644 --- a/documentation/ref-manual/figures/yocto-environment-ref.png +++ b/documentation/overview-manual/figures/yocto-environment-ref.png diff --git a/documentation/ref-manual/figures/yp-download.png b/documentation/overview-manual/figures/yp-download.png Binary files differindex 5770be6883..5770be6883 100644 --- a/documentation/ref-manual/figures/yp-download.png +++ b/documentation/overview-manual/figures/yp-download.png diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/overview-manual/overview-development-environment.xml index 543a669e05..32fe1816ab 100644 --- a/documentation/ref-manual/ref-development-environment.xml +++ b/documentation/overview-manual/overview-development-environment.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > -<chapter id='ref-development-environment'> +<chapter id='overview-development-environment'> <title>The Yocto Project Development Environment</title> <para> @@ -236,7 +236,7 @@ release to facilitate this workflow. You can find these scripts in the <filename>scripts</filename> folder of the - <link linkend='source-directory'>Source Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. For information on how to use these scripts, see the "<ulink url='&YOCTO_DOCS_DEV_URL;#pushing-a-change-upstream'>Using Scripts to Push a Change Upstream and Request a Pull</ulink>" section in the Yocto Project Development Tasks Manual. @@ -637,8 +637,8 @@ column and see the URL at the bottom of the page that you need to clone a Git repository for that particular item. Having a local Git repository of the - <link linkend='source-directory'>Source Directory</link>, which is - usually named "poky", allows + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, + which is usually named "poky", allows you to make changes, contribute to the history, and ultimately enhance the Yocto Project's tools, Board Support Packages, and so forth. </para> @@ -654,7 +654,7 @@ <itemizedlist> <listitem><para> The recommended method for setting up the Yocto Project - <link linkend='source-directory'>Source Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> and the files for supported BSPs (e.g., <filename>meta-intel</filename>) is to use <link linkend='git'>Git</link> to create a local copy of @@ -663,7 +663,7 @@ <listitem><para> Be sure to always work in matching branches for both the selected BSP repository and the - <link linkend='source-directory'>Source Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> (i.e. <filename>poky</filename>) repository. For example, if you have checked out the "master" branch of <filename>poky</filename> and you are going to use @@ -774,11 +774,11 @@ When you build an image using the Yocto Project, the build process uses a known list of licenses to ensure compliance. You can find this list in the - <link linkend='source-directory'>Source Directory</link> at - <filename>meta/files/common-licenses</filename>. + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> + at <filename>meta/files/common-licenses</filename>. Once the build completes, the list of all licenses found and used during that build are kept in the - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> at <filename>tmp/deploy/licenses</filename>. </para> @@ -809,7 +809,7 @@ You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses in the <filename>meta/files/common-licenses</filename> directory in your - <link linkend='source-directory'>Source Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. </para> <para> @@ -1061,9 +1061,9 @@ You can use overrides to set a value conditionally, typically based on how the recipe is being built. For example, to set the - <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable's value to "standard/base" for any target - <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>, except for qemuarm where it should be set to "standard/arm-versatile-926ejs", you would do the following: @@ -1074,9 +1074,9 @@ Overrides are also used to separate alternate values of a variable in other situations. For example, when setting variables such as - <link linkend='var-FILES'><filename>FILES</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'><filename>FILES</filename></ulink> and - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink> that are specific to individual packages produced by a recipe, you should always use an override that specifies the name of the package. @@ -1127,7 +1127,7 @@ The following diagram represents development at a high level. The remainder of this chapter expands on the fundamental input, output, process, and - <link linkend='metadata'>Metadata</link>) blocks + <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>) blocks that make up development in the Yocto Project environment. </para> @@ -1148,7 +1148,7 @@ Upstream releases, local projects, and SCMs.</para></listitem> <listitem><para><emphasis>Build System:</emphasis> Processes under the control of - <link linkend='bitbake-term'>BitBake</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>. This block expands on how BitBake fetches source, applies patches, completes compilation, analyzes output for package generation, creates and tests packages, generates images, and @@ -1187,7 +1187,7 @@ </para> <para> - <imagedata fileref="figures/user-configuration.png" align="center" /> + <imagedata fileref="figures/user-configuration.png" align="center" width="8in" depth="4.5in" /> </para> <para> @@ -1195,7 +1195,7 @@ a build. These files are <filename>*.conf</filename> files. The minimally necessary ones reside as example files in the - <link linkend='source-directory'>Source Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. For simplicity, this section refers to the Source Directory as the "Poky Directory." </para> @@ -1221,12 +1221,12 @@ configuration files when you source the build environment script (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). + <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). </para> <para> Sourcing the build environment script creates a - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> if one does not already exist. BitBake uses the Build Directory for all its work during builds. The Build Directory has a <filename>conf</filename> directory that @@ -1273,26 +1273,26 @@ <itemizedlist> <listitem><para><emphasis>Parallelism Options:</emphasis> Controlled by the - <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>, - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, and <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> variables.</para></listitem> <listitem><para><emphasis>Target Machine Selection:</emphasis> Controlled by the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable.</para></listitem> <listitem><para><emphasis>Download Directory:</emphasis> Controlled by the - <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> variable.</para></listitem> <listitem><para><emphasis>Shared State Directory:</emphasis> Controlled by the - <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> variable.</para></listitem> <listitem><para><emphasis>Build Output:</emphasis> Controlled by the - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> variable.</para></listitem> </itemizedlist> <note> @@ -1332,11 +1332,11 @@ You can set these default build properties here. A good example is perhaps the packaging format to use through the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> variable.</para> <para>One useful scenario for using the <filename>conf/site.conf</filename> file is to extend your - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink> variable to include the path to a <filename>conf/site.conf</filename>. Then, when BitBake looks for Metadata using @@ -1495,7 +1495,8 @@ When your recipes inherit a class, they take on the settings and functions for that class. You can read more about class files in the - "<link linkend='ref-classes'>Classes</link>" section. + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes'>Classes</ulink>" + section of the Yocto Reference Manual. </para></listitem> <listitem><para><emphasis>conf:</emphasis> This area holds configuration files for the @@ -1605,7 +1606,7 @@ <para> BitBake uses the - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable to point to source files regardless of their location. Each recipe must have a <filename>SRC_URI</filename> variable that points to the source. @@ -1614,13 +1615,13 @@ <para> Another area that plays a significant role in where source files come from is pointed to by the - <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> variable. This area is a cache that can hold previously downloaded source. You can also instruct the OpenEmbedded build system to create tarballs from Git repositories, which is not the default behavior, and store them in the <filename>DL_DIR</filename> by using the - <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink> variable. </para> @@ -1671,7 +1672,7 @@ <para> The canonical method through which to include a local project is to use the - <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc</filename></ulink> class to include that local project. You use either the <filename>local.conf</filename> or a recipe's append file to override or set the @@ -1682,7 +1683,7 @@ <para> For information on how to use the <filename>externalsrc</filename> class, see the - "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink>" section. </para> </section> @@ -1695,9 +1696,9 @@ through an SCM such as Git or Subversion. In this case, a repository is cloned or checked out. The - <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink> task inside BitBake uses - the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + the <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable and the argument's prefix to determine the correct fetcher module. </para> @@ -1705,15 +1706,15 @@ <note> For information on how to have the OpenEmbedded build system generate tarballs for Git repositories and place them in the - <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> directory, see the - <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink> variable. </note> <para> When fetching a repository, BitBake uses the - <link linkend='var-SRCREV'><filename>SRCREV</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> variable to determine the specific revision from which to build. </para> @@ -1724,15 +1725,16 @@ <para> Two kinds of mirrors exist: pre-mirrors and regular mirrors. - The <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + The + <ulink url='&YOCTO_DOCS_REF_URL;#var-PREMIRRORS'><filename>PREMIRRORS</filename></ulink> and - <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-MIRRORS'><filename>MIRRORS</filename></ulink> variables point to these, respectively. BitBake checks pre-mirrors before looking upstream for any source files. Pre-mirrors are appropriate when you have a shared directory that is not a directory defined by the - <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> variable. A Pre-mirror typically points to a shared directory that is local to your organization. @@ -1752,7 +1754,7 @@ <para> When the OpenEmbedded build system generates an image or an SDK, it gets the packages from a package feed area located in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. The <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> shows this package feeds area in the upper-right corner. @@ -1770,12 +1772,12 @@ The OpenEmbedded build system provides classes to generate different package types, and you specify which classes to enable through the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> variable. Before placing the packages into package feeds, the build process validates them with generated output quality assurance checks through the - <link linkend='ref-classes-insane'><filename>insane</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-insane'><filename>insane</filename></ulink> class. </para> @@ -1789,7 +1791,7 @@ In particular, the following defines where package files are kept: <itemizedlist> - <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>: Defined as <filename>tmp/deploy</filename> in the Build Directory. </para></listitem> @@ -1797,14 +1799,14 @@ Depending on the package manager used, the package type sub-folder. Given RPM, IPK, or DEB packaging and tarball creation, the - <link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link>, - <link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link>, - <link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></ulink>, or - <link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link>, + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></ulink>, variables are used, respectively. </para></listitem> - <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>: Defines architecture-specific sub-folders. For example, packages could exist for the i586 or qemux86 architectures. @@ -1817,11 +1819,11 @@ generate packages and place them into the package holding area (e.g. <filename>do_package_write_ipk</filename> for IPK packages). See the - "<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>", - "<link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>", - "<link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>", + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></ulink>", + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></ulink>", + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></ulink>", and - "<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>" + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></ulink>" sections for additional information. As an example, consider a scenario where an IPK packaging manager is being used and package architecture support for both i586 @@ -1838,7 +1840,7 @@ <para> The OpenEmbedded build system uses - <link linkend='bitbake-term'>BitBake</link> + <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> to produce images. You can see from the <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, @@ -1864,15 +1866,15 @@ <para> The - <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink> and - <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink> tasks fetch the source files and unpack them into the work directory. <note> For every local file (e.g. <filename>file://</filename>) that is part of a recipe's - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> statement, the OpenEmbedded build system takes a checksum of the file for the recipe and inserts the checksum into the signature for the <filename>do_fetch</filename>. @@ -1881,17 +1883,18 @@ depend on it are re-executed. </note> By default, everything is accomplished in the - <link linkend='build-directory'>Build Directory</link>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, which has a defined structure. For additional general information on the Build Directory, see the - "<link linkend='structure-core-build'><filename>build/</filename></link>" - section. + "<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-build'><filename>build/</filename></ulink>" + section in the Yocto Project Reference Manual. </para> <para> Unpacked source files are pointed to by the - <link linkend='var-S'><filename>S</filename></link> variable. + <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> + variable. Each recipe has an area in the Build Directory where the unpacked source code resides. The name of that directory for any given recipe is defined from @@ -1899,30 +1902,30 @@ You can see the variables that define these directories by looking at the figure: <itemizedlist> - <listitem><para><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> - The base directory where the OpenEmbedded build system performs all its work during the build. </para></listitem> - <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink> - The architecture of the built package or packages. </para></listitem> - <listitem><para><link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink> - The operating system of the target device. </para></listitem> - <listitem><para><link linkend='var-PN'><filename>PN</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink> - The name of the built package. </para></listitem> - <listitem><para><link linkend='var-PV'><filename>PV</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> - The version of the recipe used to build the package. </para></listitem> - <listitem><para><link linkend='var-PR'><filename>PR</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> - The revision of the recipe used to build the package. </para></listitem> - <listitem><para><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink> - The location within <filename>TMPDIR</filename> where a specific package is built. </para></listitem> - <listitem><para><link linkend='var-S'><filename>S</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> - Contains the unpacked source files for a given recipe. </para></listitem> </itemizedlist> @@ -1940,10 +1943,10 @@ <para> The - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> task processes recipes by using the - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable to locate applicable patch files, which by default are <filename>*.patch</filename> or <filename>*.diff</filename> files, or any file if @@ -1955,7 +1958,8 @@ BitBake finds and applies multiple patches for a single recipe in the order in which it finds the patches. Patches are applied to the recipe's source files located in the - <link linkend='var-S'><filename>S</filename></link> directory. + <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> + directory. </para> <para> @@ -1979,13 +1983,13 @@ This step in the build process consists of three tasks: <itemizedlist> <listitem><para> - <emphasis><link linkend='ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></link>:</emphasis> + <emphasis><ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></ulink>:</emphasis> This task sets up the two sysroots in - <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}</filename> + <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> (i.e. <filename>recipe-sysroot</filename> and <filename>recipe-sysroot-native</filename>) so that the sysroots contain the contents of the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></ulink> tasks of the recipes on which the recipe containing the tasks depends. A sysroot exists for both the target and for the native @@ -2002,18 +2006,19 @@ </para> <para>The configurations handled by the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink> task are specific to source code configuration for the source code being built by the recipe.</para> <para>If you are using the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink> class, you can add additional configuration options by using - the <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> + the + <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink> or - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink> variables. For information on how this variable works within that class, see the @@ -2022,23 +2027,23 @@ <listitem><para><emphasis><filename>do_compile</filename>:</emphasis> Once a configuration task has been satisfied, BitBake compiles the source using the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-compile'><filename>do_compile</filename></ulink> task. Compilation occurs in the directory pointed to by the - <link linkend='var-B'><filename>B</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink> variable. Realize that the <filename>B</filename> directory is, by default, the same as the - <link linkend='var-S'><filename>S</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> directory.</para></listitem> <listitem><para><emphasis><filename>do_install</filename>:</emphasis> Once compilation is done, BitBake executes the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink> task. This task copies files from the <filename>B</filename> directory and places them in a holding area pointed to by the - <link linkend='var-D'><filename>D</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink> variable.</para></listitem> </itemizedlist> </para> @@ -2056,12 +2061,12 @@ <para> The - <link linkend='ref-tasks-package'><filename>do_package</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package'><filename>do_package</filename></ulink> and - <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata'><filename>do_packagedata</filename></ulink> tasks combine to analyze the files found in the - <link linkend='var-D'><filename>D</filename></link> directory + <ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink> directory and split them into subsets based on available packages and files. The analyzing process involves the following as well as other @@ -2074,29 +2079,29 @@ Working, staged, and intermediate results of the analysis and package splitting process use these areas: <itemizedlist> - <listitem><para><link linkend='var-PKGD'><filename>PKGD</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGD'><filename>PKGD</filename></ulink> - The destination directory for packages before they are split. </para></listitem> - <listitem><para><link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></ulink> - A shared, global-state directory that holds data generated during the packaging process. </para></listitem> - <listitem><para><link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGDESTWORK'><filename>PKGDESTWORK</filename></ulink> - A temporary work area used by the <filename>do_package</filename> task. </para></listitem> - <listitem><para><link linkend='var-PKGDEST'><filename>PKGDEST</filename></link> - + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGDEST'><filename>PKGDEST</filename></ulink> - The parent directory for packages after they have been split. </para></listitem> </itemizedlist> - The <link linkend='var-FILES'><filename>FILES</filename></link> + The <ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'><filename>FILES</filename></ulink> variable defines the files that go into each package in - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. + <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>. If you want details on how this is accomplished, you can look at the - <link linkend='ref-classes-package'><filename>package</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'><filename>package</filename></ulink> class. </para> @@ -2136,31 +2141,31 @@ The image generation process consists of several stages and depends on several tasks and variables. The - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-rootfs'><filename>do_rootfs</filename></ulink> task creates the root filesystem (file and directory structure) for an image. This task uses several key variables to help create the list of packages to actually install: <itemizedlist> - <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>: Lists out the base set of packages to install from the Package Feeds area.</para></listitem> - <listitem><para><link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>: Specifies packages that should not be installed. </para></listitem> - <listitem><para><link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>: Specifies features to include in the image. Most of these features map to additional packages for installation.</para></listitem> - <listitem><para><link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>: Specifies the package backend to use and consequently helps determine where to locate packages within the Package Feeds area.</para></listitem> - <listitem><para><link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></ulink>: Determines the language(s) for which additional language support packages are installed. </para></listitem> - <listitem><para><link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></ulink>: The final list of packages passed to the package manager for installation into the image. </para></listitem> @@ -2169,7 +2174,7 @@ <para> With - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></ulink> pointing to the location of the filesystem under construction and the <filename>PACKAGE_INSTALL</filename> variable providing the final list of packages to install, the root file system is @@ -2207,11 +2212,11 @@ in the same directory as the root filesystem image. This file lists out, line-by-line, the installed packages. The manifest file is useful for the - <link linkend='ref-classes-testimage*'><filename>testimage</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-testimage*'><filename>testimage</filename></ulink> class, for example, to determine whether or not to run specific tests. See the - <link linkend='var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></ulink> variable for additional information. </para> @@ -2219,7 +2224,7 @@ Optimizing processes run across the image include <filename>mklibs</filename>, <filename>prelink</filename>, and any other post-processing commands as defined by the - <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></ulink> variable. The <filename>mklibs</filename> process optimizes the size of the libraries, while the @@ -2231,11 +2236,11 @@ <para> After the root filesystem is built, processing begins on the image through the - <link linkend='ref-tasks-image'><filename>do_image</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-image'><filename>do_image</filename></ulink> task. The build system runs any pre-processing commands as defined by the - <link linkend='var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></ulink> variable. This variable specifies a list of functions to call before the OpenEmbedded build system creates the final image output @@ -2246,7 +2251,7 @@ The OpenEmbedded build system dynamically creates <filename>do_image_*</filename> tasks as needed, based on the image types specified in the - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> variable. The process turns everything into an image file or a set of image files and compresses the root filesystem image to reduce @@ -2273,11 +2278,11 @@ <para> The final task involved in image creation is the - <link linkend='ref-tasks-image-complete'><filename>do_image_complete</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-image-complete'><filename>do_image_complete</filename></ulink> task. This task completes the image by applying any image post processing as defined through the - <link linkend='var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></ulink> variable. The variable specifies a list of functions to call once the OpenEmbedded build system has created the final image output @@ -2304,11 +2309,11 @@ <note> For more information on the cross-development toolchain generation, see the - "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" - section. + "<ulink url='&YOCTO_DOCS_REF_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" + section in the Yocto Project Reference Manual. For information on advantages gained when building a cross-development toolchain using the - <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></ulink> task, see the "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" section in the Yocto Project Application Development and the @@ -2334,7 +2339,7 @@ The target part is the part built for the target hardware and includes libraries and headers. The host part is the part of the SDK that runs on the - <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. + <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>. </para> <para> @@ -2362,10 +2367,10 @@ <para> For each task that completes successfully, BitBake writes a stamp file into the - <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-STAMPS_DIR'><filename>STAMPS_DIR</filename></ulink> directory. The beginning of the stamp file's filename is determined by the - <link linkend='var-STAMP'><filename>STAMP</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-STAMP'><filename>STAMP</filename></ulink> variable, and the end of the name consists of the task's name and current <ulink url='&YOCTO_DOCS_BB_URL;#checksums'>input checksum</ulink>. @@ -2392,9 +2397,9 @@ serve as a marker that some work has been done and that these files do not record task output. The actual task output would usually be somewhere in - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> (e.g. in some recipe's - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.) + <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>.) What the sstate cache mechanism adds is a way to cache task output that can then be shared between build machines. </para> @@ -2419,8 +2424,8 @@ <para> For details on how to view information about a task's signature, see the - "<link linkend='usingpoky-viewing-task-variable-dependencies'>Viewing Task Variable Dependencies</link>" - section. + "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-viewing-task-variable-dependencies'>Viewing Task Variable Dependencies</ulink>" + section in the Yocto Project Reference Manual. </para> </section> @@ -2436,9 +2441,9 @@ shared state (sstate) cache. <note> For information on variables affecting sstate, see the - <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> and - <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></ulink> variables. </note> </para> @@ -2454,21 +2459,22 @@ (e.g. generating package files in the <filename>do_package_write_*</filename> task). In other cases, it does not make sense, (e.g. a - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> task or - <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink> task) since the work involved would be equal to or greater than the underlying task. </para> <para> In the OpenEmbedded build system, the common tasks that have - setscene variants are <link linkend='ref-tasks-package'><filename>do_package</filename></link>, + setscene variants are + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package'><filename>do_package</filename></ulink>, <filename>do_package_write_*</filename>, - <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link>, - <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>, + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-deploy'><filename>do_deploy</filename></ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata'><filename>do_packagedata</filename></ulink>, and - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>. + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></ulink>. Notice that these are most of the tasks whose output is an end result. </para> @@ -2556,27 +2562,30 @@ <para> For a list of example images that the Yocto Project provides, see the - "<link linkend='ref-images'>Images</link>" chapter. + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" + chapter in the Yocto Project Reference Manual. </para> <para> Images are written out to the - <link linkend='build-directory'>Build Directory</link> - inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> + inside the + <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> folder as shown in the figure. This folder contains any files expected to be loaded on the target device. The - <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink> variable points to the <filename>deploy</filename> directory, while the - <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></ulink> variable points to the appropriate directory containing images for the current configuration. <itemizedlist> <listitem><para><filename><replaceable>kernel-image</replaceable></filename>: A kernel binary file. - The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> + The + <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></ulink> variable setting determines the naming scheme for the kernel image file. Depending on that variable, the file could begin with @@ -2588,7 +2597,8 @@ Root filesystems for the target device (e.g. <filename>*.ext3</filename> or <filename>*.bz2</filename> files). - The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + The + <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> variable setting determines the root filesystem image type. The <filename>deploy/images/<replaceable>machine</replaceable></filename> @@ -2598,7 +2608,7 @@ Tarballs that contain all the modules built for the kernel. Kernel module tarballs exist for legacy purposes and can be suppressed by setting the - <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></ulink> variable to "0". The <filename>deploy/images/<replaceable>machine</replaceable></filename> directory can contain multiple kernel module tarballs @@ -2654,49 +2664,52 @@ the environment before using the tools. </para> - <note> - <para> - The Yocto Project supports several methods by which you can - set up this cross-development environment. - These methods include downloading pre-built SDK installers - or building and installing your own SDK installer. - </para> - - <para> - For background information on cross-development toolchains - in the Yocto Project development environment, see the - "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" - section. - For information on setting up a cross-development - environment, see the - <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - </para> + <note><title>Notes</title> + <itemizedlist> + <listitem><para> + The Yocto Project supports several methods by which you can + set up this cross-development environment. + These methods include downloading pre-built SDK installers + or building and installing your own SDK installer. + </para></listitem> + <listitem><para> + For background information on cross-development toolchains + in the Yocto Project development environment, see the + "<ulink url='&YOCTO_DOCS_REF_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" + section in the Yocto Project Reference Manual. + </para></listitem> + <listitem><para> + For information on setting up a cross-development + environment, see the + <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> + manual. + </para></listitem> + </itemizedlist> </note> <para> Once built, the SDK installers are written out to the <filename>deploy/sdk</filename> folder inside the - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> as shown in the figure at the beginning of this section. Depending on the type of SDK, several variables exist that help configure these files. The following list shows the variables associated with a standard SDK: <itemizedlist> - <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>: Points to the <filename>deploy</filename> directory.</para></listitem> - <listitem><para><link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>: Specifies the architecture of the machine on which the cross-development tools are run to create packages for the target hardware. </para></listitem> - <listitem><para><link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></ulink>: Lists the features to include in the "target" part of the SDK. </para></listitem> - <listitem><para><link linkend='var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>: Lists packages that make up the host part of the SDK (i.e. the part that runs on the <filename>SDKMACHINE</filename>). @@ -2706,12 +2719,12 @@ apply. This variable allows you to add more packages. </para></listitem> - <listitem><para><link linkend='var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>: Lists packages that make up the target part of the SDK (i.e. the part built for the target hardware). </para></listitem> - <listitem><para><link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDKPATH'><filename>SDKPATH</filename></ulink>: Defines the default SDK installation path offered by the installation script. </para></listitem> @@ -2719,34 +2732,34 @@ This next list, shows the variables associated with an extensible SDK: <itemizedlist> - <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>: Points to the <filename>deploy</filename> directory. </para></listitem> - <listitem><para><link linkend='var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></ulink>: Controls whether or not shared state artifacts are copied into the extensible SDK. By default, all required shared state artifacts are copied into the SDK. </para></listitem> - <listitem><para><link linkend='var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></ulink>: Specifies whether or not packagedata will be included in the extensible SDK for all recipes in the "world" target. </para></listitem> - <listitem><para><link linkend='var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink>: Specifies whether or not the toolchain will be included when building the extensible SDK. </para></listitem> - <listitem><para><link linkend='var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></ulink>: A list of variables allowed through from the build system configuration into the extensible SDK configuration. </para></listitem> - <listitem><para><link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></ulink>: A list of variables not allowed through from the build system configuration into the extensible SDK configuration. </para></listitem> - <listitem><para><link linkend='var-SDK_INHERIT_BLACKLIST'><filename>SDK_INHERIT_BLACKLIST</filename></link>: + <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INHERIT_BLACKLIST'><filename>SDK_INHERIT_BLACKLIST</filename></ulink>: A list of classes to remove from the - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> + <ulink url='&YOCTO_DOCS_REF_URL;#var-INHERIT'><filename>INHERIT</filename></ulink> value globally within the extensible SDK configuration. </para></listitem> </itemizedlist> diff --git a/documentation/overview-manual/overview-manual.xml b/documentation/overview-manual/overview-manual.xml index 9eda19a8f7..9af914a924 100644 --- a/documentation/overview-manual/overview-manual.xml +++ b/documentation/overview-manual/overview-manual.xml @@ -84,6 +84,8 @@ <xi:include href="overview-manual-intro.xml"/> + <xi:include href="overview-development-environment.xml"/> + </book> <!-- vim: expandtab tw=80 ts=4 diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 11dfc5b13e..ddb5078454 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -417,10 +417,10 @@ <para> You can find more information on licensing in the - "<link linkend='licensing'>Licensing</link>" section and in the + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#licensing'>Licensing</ulink>" + section in the Yocto Project Overview Manual and also in the "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" - section, which is in the Yocto Project Development Tasks - Manual. + section in the Yocto Project Development Tasks Manual. </para> </answer> </qandaentry> diff --git a/documentation/ref-manual/figures/source-repos.png b/documentation/ref-manual/figures/source-repos.png Binary files differdeleted file mode 100644 index e9cff16cc8..0000000000 --- a/documentation/ref-manual/figures/source-repos.png +++ /dev/null diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index 3f55e73100..588d392f8e 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -1015,8 +1015,8 @@ <para>For more information on concepts related to Git repositories, branches, and tags, see the - "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#repositories-tags-and-branches'>Repositories, Tags, and Branches</ulink>" + section in the Yocto Project Overview Manual. </para></listitem> <listitem><para><emphasis>Task:</emphasis> A unit of execution for BitBake (e.g. diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 5dea5ad960..8a6b8a18fc 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -293,7 +293,7 @@ For the remainder, you can now find them in the <filename>meta-extras</filename> repository, which is in the Yocto Project - <link linkend='source-repositories'>Source Repositories</link>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>. </para> </section> </section> @@ -1748,8 +1748,8 @@ <para> The minimum - <link linkend='git'>Git</link> version required - on the build host is now 1.7.8 because the + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> version + required on the build host is now 1.7.8 because the <filename>--list</filename> option is now required by BitBake's Git fetcher. As always, if your host distribution does not provide a version of @@ -4038,7 +4038,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64. <para>For an example, see the <filename>pixbufcache</filename> class in <filename>meta/classes/</filename> in the Yocto Project - <link linkend='source-repositories'>Source Repositories</link>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>. <note> The <filename>SSTATEPOSTINSTFUNCS</filename> variable itself is now deprecated in favor of the diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 0fc88c43a7..f27f33f292 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -1249,8 +1249,8 @@ "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" section in the Yocto Project Development Tasks Manual. For information on how images are created, see the - "<link linkend='images-dev-environment'>Images</link>" section elsewhere - in this manual. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" + section in the Yocto Project Overview Manual. </para> </section> @@ -3018,8 +3018,8 @@ This check was removed for YP 2.3 release <para> For information on how root filesystem images are created, see the - "<link linkend='image-generation-dev-environment'>Image Generation</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" + section in the Yocto Project Overview Manual. </para> </section> diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index e2aed1fd38..a24a9e310d 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml @@ -170,8 +170,6 @@ <xi:include href="usingpoky.xml"/> - <xi:include href="ref-development-environment.xml"/> - <xi:include href="technical-details.xml"/> <xi:include href="ref-release-process.xml"/> diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml index e2902eb38b..1b36932e21 100644 --- a/documentation/ref-manual/ref-release-process.xml +++ b/documentation/ref-manual/ref-release-process.xml @@ -61,7 +61,7 @@ <para> Each major release receives a codename that identifies the release in the - <link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>. The concept is that branches of <link linkend='metadata'>Metadata</link> with the same codename are likely to be compatible and thus @@ -217,7 +217,7 @@ in the <filename>poky</filename> repository. <note> You can find all these branches in the Yocto Project - <link linkend='source-repositories'>Source Repositories</link>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>. </note> Testing within these public branches ensures in a publicly visible way that all of the main supposed architectures and recipes in OE-Core diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 4bddc59965..ad8f24efd7 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -520,9 +520,10 @@ variable points to this directory. For more detail on the contents of the <filename>deploy</filename> directory, see the - "<link linkend='images-dev-environment'>Images</link>" and - "<link linkend='sdk-dev-environment'>Application Development SDK</link>" - sections. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" + and + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" + sections in the Yocto Project Overview Manual. </para> </section> @@ -695,8 +696,8 @@ <para> For information on how BitBake uses stamp files to determine if a task should be rerun, see the - "<link linkend='stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" + section in the Yocto Project Overview Manual. </para> </section> diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index c726cb904b..62a677a430 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -220,8 +220,8 @@ <para> For more information on image creation, see the - "<link linkend='image-generation-dev-environment'>Image Generation</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" + section in the Yocto Project Overview Manual. </para> </section> @@ -246,8 +246,8 @@ <para> For more information on image creation, see the - "<link linkend='image-generation-dev-environment'>Image Generation</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" + section in the Yocto Project Overview Manual. </para> </section> @@ -367,8 +367,8 @@ <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> directory in the package feeds area. For more information, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section in the Yocto Project Overview Manual. </para> </section> @@ -381,8 +381,8 @@ <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> directory in the package feeds area. For more information, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section in the Yocto Project Overview Manual. </para> </section> @@ -395,8 +395,8 @@ <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> directory in the package feeds area. For more information, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section in the Yocto Project Overview Manual. </para> </section> @@ -408,8 +408,8 @@ <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> directory in the package feeds area. For more information, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section Yocto Project Overview Manual. </para> </section> @@ -431,8 +431,8 @@ <para> Locates patch files and applies them to the source code. See the - "<link linkend='patching-dev-environment'>Patching</link>" - section for more information. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#patching-dev-environment'>Patching</ulink>" + section in the Yocto Project Overview Manual for more information. </para> </section> @@ -451,8 +451,8 @@ <para> Creates the file and directory structure for an installable SDK. See the - "<link linkend='sdk-generation-dev-environment'>SDK Generation</link>" - section for more information. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" + section in the Yocto Project Overview Manual for more information. </para> </section> @@ -538,8 +538,9 @@ <link linkend='var-S'><filename>S</filename></link> variable also plays a role in where unpacked source files ultimately reside. For more information on how source files are unpacked, see the - "<link linkend='source-fetching-dev-environment'>Source Fetching</link>" - section and the <filename>WORKDIR</filename> and + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" + section in the Yocto Project Overview Manual and also see the + <filename>WORKDIR</filename> and <filename>S</filename> variable descriptions. </para> </section> @@ -757,7 +758,7 @@ <para> Creates or updates the index in the - <link linkend='package-feeds-dev-environment'>Package Feeds</link> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink> area. <note> This task is not triggered with the @@ -809,8 +810,9 @@ Creates the root filesystem (file and directory structure) for an image. See the - "<link linkend='image-generation-dev-environment'>Image Generation</link>" - section for more information on how the root filesystem is created. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" + section in the Yocto Project Overview Manual for more information + on how the root filesystem is created. </para> </section> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 521eaeaed2..d621b3293f 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -3327,11 +3327,12 @@ section. For more detail on the contents of the <filename>deploy</filename> directory, see the - "<link linkend='images-dev-environment'>Images</link>", - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>", - and - "<link linkend='sdk-dev-environment'>Application Development SDK</link>" - sections. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" + section, the + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section, and the + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" + sections all in the Yocto Project Overview Manual. </para> </glossdef> </glossentry> @@ -3370,8 +3371,8 @@ <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> task writes Debian packages into the appropriate folder. For more information on how packaging works, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section in the Yocto Project Overview Manual. </para> </glossdef> </glossentry> @@ -3400,9 +3401,10 @@ section. For more detail on the contents of the <filename>deploy</filename> directory, see the - "<link linkend='images-dev-environment'>Images</link>" and - "<link linkend='sdk-dev-environment'>Application Development SDK</link>" - sections. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" + and + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" + sections both in the Yocto Project Overview Manual. </para> </glossdef> </glossentry> @@ -3440,8 +3442,8 @@ <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> task writes IPK packages into the appropriate folder. For more information on how packaging works, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section in the Yocto Project Overview Manual. </para> </glossdef> </glossentry> @@ -3479,7 +3481,7 @@ <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> task writes RPM packages into the appropriate folder. For more information on how packaging works, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" section. </para> </glossdef> @@ -3518,8 +3520,8 @@ <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> task writes TAR packages into the appropriate folder. For more information on how packaging works, see the - "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" + section in the Yocto Project Overview Manual. </para> </glossdef> </glossentry> @@ -4860,7 +4862,7 @@ The previous statement appears in the <filename>linux-yocto-dev.bbappend</filename> file, which is found in the Yocto Project - <link linkend='source-repositories'>Source Repositories</link> + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> in <filename>meta-intel/common/recipes-kernel/linux</filename>. Here, the machine override is a special @@ -6078,8 +6080,8 @@ variables. You can find information on how the image is created in the - "<link linkend='image-generation-dev-environment'>Image Generation</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" + section in the Yocto Project Overview Manual. </para> </glossdef> </glossentry> @@ -13687,8 +13689,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <para> For information on how BitBake uses stamp files to determine if a task should be rerun, see the - "<link linkend='stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" + section in the Yocto Project Overview Manual. </para> <para> diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index e9e76e46d7..2619a19e63 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml @@ -56,8 +56,8 @@ Following are some brief details on these core components. For additional information on how these components interact during a build, see the - "<link linkend='development-concepts'>Development Concepts</link>" - section. + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#development-concepts'>Development Concepts</ulink>" + section in the Yocto Project Overview Manual. </para> <section id='usingpoky-components-bitbake'> diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 9b0e7dd019..b1d599d225 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -640,8 +640,9 @@ <filename>-c</filename>, BitBake will only run the task if it considers it "out of date". See the - "<link linkend='stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</link>" - section for how BitBake determines whether a task is "out of date". + "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" + section in the Yocto Project Overview Manual for how BitBake + determines whether a task is "out of date". </para> <para> @@ -1481,7 +1482,7 @@ qemux86" or "qemux86-64". Enabling build history as previously described causes the OpenEmbedded build system to collect build output information and commit it as a single commit to a local - <link linkend='git'>Git</link> repository. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> repository. <note> Enabling build history increases your build times slightly, particularly for images, and increases the amount of disk diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml index ab9055e628..d2da5924c2 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.xml +++ b/documentation/sdk-manual/sdk-appendix-obtain.xml @@ -327,7 +327,7 @@ <para>Following is an example command that extracts the root filesystem from a previously built root filesystem image that was downloaded from the - <ulink url='&YOCTO_DOCS_REF_URL;#index-downloads'>Index of Releases</ulink>. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#index-downloads'>Index of Releases</ulink>. This command extracts the root filesystem into the <filename>core2-64-sato</filename> directory: <literallayout class='monospaced'> diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 444d816a71..ac6fa367ba 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -247,8 +247,8 @@ <para> The <filename>devtool</filename> command line is organized similarly to - <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> in that it has a - number of sub-commands for each function. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> in that it + has a number of sub-commands for each function. You can run <filename>devtool --help</filename> to see all the commands. <note> diff --git a/documentation/yocto-project-qs/qs.xml b/documentation/yocto-project-qs/qs.xml index 71354ed685..69ed96f41f 100644 --- a/documentation/yocto-project-qs/qs.xml +++ b/documentation/yocto-project-qs/qs.xml @@ -316,9 +316,10 @@ (CROPS), you need to get a copy of the Yocto Project. It is recommended that you get the latest Yocto Project release by setting up (cloning in - <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> terms) a - local copy of the <filename>poky</filename> Git repository on - your build host and then checking out the latest release. + <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> + terms) a local copy of the <filename>poky</filename> Git + repository on your build host and then checking out the + latest release. Doing so allows you to easily update to newer Yocto Project releases as well as contribute back to the Yocto Project. </para> |
