From 1b877bc9dd3e9048489e6868020876af812cfa5e Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 12 Apr 2018 10:57:32 -0700 Subject: documentation: Updated everything for new overview-manual This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/Makefile | 2 +- .../brief-yoctoprojectqs/brief-yoctoprojectqs.xml | 6 +-- documentation/bsp-guide/bsp.xml | 8 ++-- .../dev-manual/dev-manual-common-tasks.xml | 28 ++++++------- documentation/dev-manual/dev-manual-newbie.xml | 10 ++--- documentation/dev-manual/dev-manual-start.xml | 12 +++--- documentation/kernel-dev/kernel-dev-advanced.xml | 2 +- documentation/kernel-dev/kernel-dev-common.xml | 4 +- .../kernel-dev/kernel-dev-concepts-appx.xml | 6 +-- documentation/kernel-dev/kernel-dev-intro.xml | 2 +- .../overview-manual/overview-manual-concepts.xml | 6 +-- .../overview-manual/overview-manual-yp-intro.xml | 20 ++++----- documentation/ref-manual/faq.xml | 2 +- documentation/ref-manual/migration.xml | 6 +-- documentation/ref-manual/ref-classes.xml | 12 +++--- documentation/ref-manual/ref-images.xml | 2 +- documentation/ref-manual/ref-release-process.xml | 4 +- documentation/ref-manual/ref-structure.xml | 6 +-- .../ref-manual/ref-system-requirements.xml | 4 +- documentation/ref-manual/ref-tasks.xml | 34 +++++++-------- documentation/ref-manual/ref-terms.xml | 6 +-- documentation/ref-manual/ref-variables.xml | 48 +++++++++++----------- documentation/ref-manual/resources.xml | 4 +- documentation/sdk-manual/sdk-appendix-obtain.xml | 2 +- documentation/sdk-manual/sdk-extensible.xml | 2 +- .../toaster-manual/toaster-manual-reference.xml | 2 +- 26 files changed, 118 insertions(+), 122 deletions(-) (limited to 'documentation') diff --git a/documentation/Makefile b/documentation/Makefile index 4423807580..df0a18dacb 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -90,7 +90,7 @@ XSLTOPTS = --stringparam html.stylesheet brief-yoctoprojectqs-style.css \ --stringparam section.autolabel 0 \ --stringparam section.label.includes.component.label 0 \ --xinclude -ALLPREQ = html tarball +ALLPREQ = html eclipse tarball TARFILES = brief-yoctoprojectqs-style.css brief-yoctoprojectqs.html figures/bypqs-title.png \ figures/yocto-project-transp.png MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml index d9960398f5..116dfbd145 100644 --- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml @@ -52,7 +52,7 @@ If you want more conceptual or background information on the Yocto Project, see the - Yocto Project Overview and Concepts Manual. + Yocto Project Overview and Concepts Manual. @@ -242,7 +242,7 @@ For information on using the bitbake command, see the - "BitBake" + "BitBake" section in the Yocto Project Overview and Concepts Manual, or see the "BitBake Command" @@ -302,7 +302,7 @@ Yocto Project Overview and Concepts Manual: The - Yocto Project Overview and Concepts Manual + Yocto Project Overview and Concepts Manual is a great place to start to learn about the Yocto Project. This manual introduces you to the Yocto Project and its diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 200aed1899..a1908d38c3 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -56,7 +56,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 - Yocto Project Source Repositories + Yocto Project Source Repositories through a web interface at . If you go to that interface, you will find a list of repositories @@ -340,7 +340,7 @@ It is also intended that it will be be simple to extract information and convert it to other formats if required. The OpenEmbedded build system, through its standard - layers mechanism, + layers mechanism, can directly accept the format described as a layer. The BSP layer captures all the hardware-specific details in one place using a standard format, which is useful @@ -1056,7 +1056,7 @@ information for the project that the OpenEmbedded build system knows about. For more information on layers, see the - "The Yocto Project Layer Model" + "The Yocto Project Layer Model" section in the Yocto Project Overview and Concepts Manual. You can also reference the @@ -1687,7 +1687,7 @@ Thus, the build system can build the corresponding recipe and include the component in the image. See the - "Enabling Commercially Licensed Recipes" + "Enabling Commercially Licensed Recipes" section in the Yocto Project Overview and Concepts Manual for details on how to use these variables. diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index fd1734beec..85b3a4a8a2 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -24,7 +24,7 @@ each other. For introductory information on the Yocto Project Layer Model, see the - "The Yocto Project Layer Model" + "The Yocto Project Layer Model" section in the Yocto Project Overview and Concepts Manual. @@ -1855,7 +1855,7 @@ You can find more information about the build process in - "The Yocto Project Development Environment" + "The Yocto Project Development Environment" chapter of the Yocto Project Overview and Concepts Manual. @@ -1872,7 +1872,7 @@ Your recipe must have a SRC_URI variable that points to where the source is located. For a graphical representation of source locations, see the - "Sources" + "Sources" section in the Yocto Project Overview and Concepts Manual. @@ -2185,7 +2185,7 @@ containing the current checksum. For more explanation and examples of how to set the LIC_FILES_CHKSUM variable, see the - "Tracking License Changes" + "Tracking License Changes" section in the Yocto Project Overview and Concepts Manual. @@ -2334,7 +2334,7 @@ automatically add a runtime dependency to "mypackage" on "example"). See the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual for further details. @@ -3398,7 +3398,7 @@ The variable LIC_FILES_CHKSUM is used to track source license changes as described in the - "Tracking License Changes" + "Tracking License Changes" section in the Yocto Project Overview and Concepts Manual. You can quickly create Autotool-based recipes in a manner similar to the previous example. @@ -3606,7 +3606,7 @@ allows runtime dependencies between packages to be added automatically. See the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual for more information. @@ -6347,7 +6347,7 @@ can use an existing file provided by the Wic installation. As shipped, kickstart files can be found in the Yocto Project - Source Repositories + Source Repositories in the following two locations: poky/meta-yocto-bsp/wic @@ -8506,7 +8506,7 @@ Some notes from Cal: Because the OpenEmbedded build system uses - "signatures", + "signatures", which are unique to a given build, the build system knows when to rebuild packages. All the inputs into a given task are represented by a @@ -8610,7 +8610,7 @@ Some notes from Cal: For more information on shared state, see the - "Shared State Cache" + "Shared State Cache" section in the Yocto Project Overview and Concepts Manual. @@ -8856,7 +8856,7 @@ Some notes from Cal: connman.inc file in the meta/recipes-connectivity/connman/ directory of the poky - source repository. + source repository. You can also find examples in meta/classes/kernel.bbclass. @@ -10399,7 +10399,7 @@ Some notes from Cal: 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 - Git + Git repository. Enabling build history increases your build times slightly, @@ -12261,7 +12261,7 @@ Some notes from Cal: ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 For tasks that are accelerated through the shared state - (sstate) + (sstate) cache, an additional siginfo file is written into SSTATE_DIR @@ -12370,7 +12370,7 @@ Some notes from Cal: -c, BitBake will only run the task if it considers it "out of date". See the - "Stamp Files and the Rerunning of Tasks" + "Stamp Files and the Rerunning of Tasks" section in the Yocto Project Overview and Concepts Manual for how BitBake determines whether a task is "out of date". diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 1579a4e89e..6ccf21882b 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 - Git. + Git. Git is a distributed system that is easy to backup, allows you to work remotely, and then connects back to the infrastructure. @@ -311,7 +311,7 @@ Use - Git + Git as the source control system. @@ -325,7 +325,7 @@ Separate the project's Metadata and code by using separate Git repositories. See the - "Yocto Project Source Repositories" + "Yocto Project Source Repositories" section for information on these repositories. See the "Working With Yocto Project Source Files" @@ -549,7 +549,7 @@ pull the change into the component's upstream repository. You do this by pushing to a contribution repository that is upstream. See the - "Git Workflows and the Yocto Project" + "Git Workflows and the Yocto Project" section in the Yocto Project Overview and Concepts Manual for additional concepts on working in the Yocto Project development environment. @@ -749,7 +749,7 @@ Search by File: - Using Git, + Using Git, you can enter the following command to bring up a short list of all commits against a specific file: diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index f7f274bc8d..87d8757a09 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -260,12 +260,12 @@ For concepts and introductory information about Git as it is used in the Yocto Project, see the - "Git" + "Git" section in the Yocto Project Overview and Concepts Manual. For concepts on Yocto Project source repositories, see the - "Yocto Project Source Repositories" + "Yocto Project Source Repositories" section in the Yocto Project Overview and Concepts Manual." @@ -277,7 +277,7 @@ Working from a copy of the upstream Yocto Project - Source Repositories + Source Repositories is the preferred method for obtaining and using a Yocto Project release. You can view the Yocto Project Source Repositories at @@ -306,7 +306,7 @@ Find the URL Used to Clone the Repository: At the bottom of the page, note the URL used to - clone + clone that repository (e.g. &YOCTO_GIT_URL;/poky). @@ -473,7 +473,7 @@ You create your Source Directory by using - Git to clone a local + Git to clone a local copy of the upstream poky repository. Tip The preferred method of getting the Yocto Project Source @@ -748,7 +748,7 @@ Build Directory under tmp/deploy/images. For detailed information on the build process using BitBake, see the - "Images" + "Images" section in the Yocto Project Overview and Concepts Manual. diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index cf8d34dced..e152295233 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml @@ -21,7 +21,7 @@ Kernel Metadata exists in many places. One area in the Yocto Project - Source Repositories + Source Repositories is the yocto-kernel-cache 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 d8eeb9ec50..6cc7b57ee7 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -79,7 +79,7 @@ The previous commands assume the - Source Repositories + Source Repositories (i.e. poky) have been cloned using Git and the local repository is named "poky". @@ -303,7 +303,7 @@ The previous commands assume the - Source Repositories + Source Repositories (i.e. poky) 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 46b5df0773..6d675a6d51 100644 --- a/documentation/kernel-dev/kernel-dev-concepts-appx.xml +++ b/documentation/kernel-dev/kernel-dev-concepts-appx.xml @@ -49,7 +49,7 @@ You can find a web interface to the Yocto Linux kernels in the - Source Repositories + Source Repositories at . If you look at the interface, you will see to the left a @@ -239,7 +239,7 @@ . You can also get an introduction to Git as it applies to the Yocto Project in the - "Git" + "Git" section in the Yocto Project Overview and Concepts Manual. The latter reference provides an overview of @@ -382,7 +382,7 @@ generic kernel just for conceptual purposes. Also keep in mind that this structure represents the Yocto Project - Source Repositories + Source Repositories 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/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml index ab087ce529..4e4fd282a5 100644 --- a/documentation/kernel-dev/kernel-dev-intro.xml +++ b/documentation/kernel-dev/kernel-dev-intro.xml @@ -112,7 +112,7 @@ document. - Yocto Project Overview and Concepts Manual. + Yocto Project Overview and Concepts Manual. devtool workflow diff --git a/documentation/overview-manual/overview-manual-concepts.xml b/documentation/overview-manual/overview-manual-concepts.xml index 123cf15d19..5067e3f627 100644 --- a/documentation/overview-manual/overview-manual-concepts.xml +++ b/documentation/overview-manual/overview-manual-concepts.xml @@ -203,8 +203,8 @@ For more introductory information on the Yocto Project's layer model, see the - "The Yocto Project Layer Model" - section in the Yocto Project Overview and Concepts Manual. + "The Yocto Project Layer Model" + section. For procedures on how to create layers, see the "Understanding and Creating Layers" section in the Yocto Project Development Tasks Manual. @@ -1567,7 +1567,7 @@ STAMP variable, and the end of the name consists of the task's name and current - input checksum. + input checksum. This naming scheme assumes that BB_SIGNATURE_HANDLER diff --git a/documentation/overview-manual/overview-manual-yp-intro.xml b/documentation/overview-manual/overview-manual-yp-intro.xml index 437635842a..c38de74fd1 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.xml +++ b/documentation/overview-manual/overview-manual-yp-intro.xml @@ -654,9 +654,8 @@ when they do not. You can read more about Pseudo in the - "Fakeroot and Pseudo" - section of the Yocto Project Overview and Concepts - Manual. + "Fakeroot and Pseudo" + section. @@ -695,10 +694,8 @@ the Yocto Project. The Yocto Project and the OpenEmbedded Project both maintain the OpenEmbedded-Core. - You can find the OE-Core metadata in the Yocto - Project - Source Repositories - here. + You can find the OE-Core metadata in the Yocto Project + Source Repositories. Historically, the Yocto Project integrated the @@ -777,9 +774,8 @@ in constrained environments. You can find the Matchbox source in its - repository - listed in the Yocto Project - Source Repositories. + repository + listed in the Yocto Project Source Repositories. Opkg @@ -1143,8 +1139,8 @@ For a very detailed look at this workflow, see the - "Development Concepts" - section in the Yocto Project Overview and Concepts Manual. + "Development Concepts" + section. diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 770162c0ef..49ff86261d 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -417,7 +417,7 @@ You can find more information on licensing in the - "Licensing" + "Licensing" section in the Yocto Project Overview and Concepts Manual and also in the "Maintaining Open Source License Compliance During Your Product's Lifecycle" diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index d8620eefd9..9a6aab95ab 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 meta-extras repository, which is in the Yocto Project - Source Repositories. + Source Repositories. @@ -1748,7 +1748,7 @@ The minimum - Git version + Git version required on the build host is now 1.7.8 because the --list option is now required by BitBake's Git fetcher. @@ -4038,7 +4038,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64. For an example, see the pixbufcache class in meta/classes/ in the Yocto Project - Source Repositories. + Source Repositories. The SSTATEPOSTINSTFUNCS 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 e419e1321c..e432fd52aa 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -568,7 +568,7 @@ provides support for the recipes that build the Canadian Cross-compilation tools for SDKs. See the - "Cross-Development Toolchain Generation" + "Cross-Development Toolchain Generation" section in the Yocto Project Overview and Concepts Manual for more discussion on these cross-compilation tools. @@ -582,7 +582,7 @@ provides support for the recipes that build the cross-compilation tools used for building SDKs. See the - "Cross-Development Toolchain Generation" + "Cross-Development Toolchain Generation" section in the Yocto Project Overview and Concepts Manual for more discussion on these cross-compilation tools. @@ -1251,7 +1251,7 @@ "Customizing Images" section in the Yocto Project Development Tasks Manual. For information on how images are created, see the - "Images" + "Images" section in the Yocto Project Overview and Concpets Manual. @@ -2722,7 +2722,7 @@ This check was removed for YP 2.3 release For more information on the cross-development toolchain generation, see the - "Cross-Development Toolchain Generation" + "Cross-Development Toolchain Generation" section in the Yocto Project Overview and Concepts Manual. For information on advantages gained when building a cross-development toolchain using the @@ -3020,7 +3020,7 @@ This check was removed for YP 2.3 release For information on how root filesystem images are created, see the - "Image Generation" + "Image Generation" section in the Yocto Project Overview and Concepts Manual. @@ -3182,7 +3182,7 @@ This check was removed for YP 2.3 release For more information on sstate, see the - "Shared State Cache" + "Shared State Cache" section in the Yocto Project Overview and Concepts Manual. diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml index 0cfa5f3543..7f33eb649f 100644 --- a/documentation/ref-manual/ref-images.xml +++ b/documentation/ref-manual/ref-images.xml @@ -151,7 +151,7 @@ This image provides the Wayland protocol libraries and the reference Weston compositor. For more information, see the - "Wayland" + "Wayland" section in the Yocto Project Overview and Concepts Manual. core-image-x11: diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml index d8ead1399b..c665cd938e 100644 --- a/documentation/ref-manual/ref-release-process.xml +++ b/documentation/ref-manual/ref-release-process.xml @@ -61,7 +61,7 @@ Each major release receives a codename that identifies the release in the - Yocto Project Source Repositories. + Yocto Project Source Repositories. The concept is that branches of Metadata with the same codename are likely to be compatible and thus @@ -217,7 +217,7 @@ in the poky repository. You can find all these branches in the Yocto Project - Source Repositories. + Source Repositories. 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 07f4e7c490..b42ea119d3 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -520,9 +520,9 @@ variable points to this directory. For more detail on the contents of the deploy directory, see the - "Images" + "Images" and - "Application Development SDK" + "Application Development SDK" sections in the Yocto Project Overview and Concepts Manual. @@ -696,7 +696,7 @@ For information on how BitBake uses stamp files to determine if a task should be rerun, see the - "Stamp Files and the Rerunning of Tasks" + "Stamp Files and the Rerunning of Tasks" section in the Yocto Project Overview and Concepts Manual. diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml index cc6a172bf9..00d9678dbe 100644 --- a/documentation/ref-manual/ref-system-requirements.xml +++ b/documentation/ref-manual/ref-system-requirements.xml @@ -21,7 +21,7 @@ For introductory information on the Yocto Project, see the Yocto Project Website and the - "Yocto Project Development Environment" + "Yocto Project Development Environment" chapter in the Yocto Project Overview and Concepts Manual. @@ -33,7 +33,7 @@ You can find "how-to" information in the Yocto Project Development Tasks Manual. You can find Yocto Project overview and conceptual information in the - Yocto Project Overview and Concepts Manual. + Yocto Project Overview and Concepts Manual. Tip For more information about the Yocto Project Documentation set, see the diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 3226b17299..c551ff0f90 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -220,7 +220,7 @@ For more information on image creation, see the - "Image Generation" + "Image Generation" section in the Yocto Project Overview and Concepts Manual. @@ -246,7 +246,7 @@ For more information on image creation, see the - "Image Generation" + "Image Generation" section in the Yocto Project Overview and Concepts Manual. @@ -268,7 +268,7 @@ and do_rootfs), run under - fakeroot. + fakeroot. Caution @@ -342,7 +342,7 @@ For additional information, see the PKGDESTWORK variable and the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual. @@ -367,7 +367,7 @@ ${DEPLOY_DIR_DEB} directory in the package feeds area. For more information, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -381,7 +381,7 @@ ${DEPLOY_DIR_IPK} directory in the package feeds area. For more information, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -395,7 +395,7 @@ ${DEPLOY_DIR_RPM} directory in the package feeds area. For more information, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -408,7 +408,7 @@ ${DEPLOY_DIR_TAR} directory in the package feeds area. For more information, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -431,7 +431,7 @@ Locates patch files and applies them to the source code. See the - "Patching" + "Patching" section in the Yocto Project Overview and Concepts Manual for more information. @@ -452,7 +452,7 @@ Creates the file and directory structure for an installable SDK. See the - "SDK Generation" + "SDK Generation" section in the Yocto Project Overview and Concepts Manual for more information. @@ -540,7 +540,7 @@ S variable also plays a role in where unpacked source files ultimately reside. For more information on how source files are unpacked, see the - "Source Fetching" + "Source Fetching" section in the Yocto Project Overview and Concepts Manual and also see the WORKDIR and S variable descriptions. @@ -620,7 +620,7 @@ Running this task does not remove the - sstate + sstate cache files. Consequently, if no changes have been made and the recipe is rebuilt after cleaning, output files are simply restored from the @@ -637,7 +637,7 @@ Removes all output files, shared state - (sstate) + (sstate) cache, and downloaded source files for a target (i.e. the contents of DL_DIR). @@ -668,13 +668,13 @@ Removes all output files and shared state - (sstate) + (sstate) cache for a target. Essentially, the do_cleansstate task is identical to the do_clean task with the added removal of shared state - (sstate) + (sstate) cache. @@ -744,7 +744,7 @@ Creates or updates the index in the - Package Feeds + Package Feeds area. This task is not triggered with the @@ -796,7 +796,7 @@ Creates the root filesystem (file and directory structure) for an image. See the - "Image Generation" + "Image Generation" section in the Yocto Project Overview and Concepts Manual for more information on how the root filesystem is created. diff --git a/documentation/ref-manual/ref-terms.xml b/documentation/ref-manual/ref-terms.xml index 31bcbe6e0b..a0c0371339 100644 --- a/documentation/ref-manual/ref-terms.xml +++ b/documentation/ref-manual/ref-terms.xml @@ -200,7 +200,7 @@ Creation of these toolchains is simple and automated. For information on toolchain concepts as they apply to the Yocto Project, see the - "Cross-Development Toolchain Generation" + "Cross-Development Toolchain Generation" section in the Yocto Project Overview and Concepts Manual. You can also find more information on using the relocatable toolchain in the @@ -245,7 +245,7 @@ Yocto Project. For introductory information on layers, see the - "The Yocto Project Layer Model" + "The Yocto Project Layer Model" section in the Yocto Project Overview and Concepts Manual. For more detailed information on layers, see the "Understanding and Creating Layers" @@ -470,7 +470,7 @@ For more information on concepts related to Git repositories, branches, and tags, see the - "Repositories, Tags, and Branches" + "Repositories, Tags, and Branches" section in the Yocto Project Overview and Concepts Manual. Task: diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 01bbc1c473..0287b910a0 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -3017,7 +3017,7 @@ Caution Tasks that read from or write to this directory should run under - fakeroot. + fakeroot. @@ -3264,7 +3264,7 @@ add any runtime dependencies between the packages produced by the two recipes. However, as explained in the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual, runtime dependencies will often be added automatically, meaning @@ -3329,10 +3329,10 @@ section. For more detail on the contents of the deploy directory, see the - "Images", - "Package Feeds", + "Images", + "Package Feeds", and - "Application Development SDK" + "Application Development SDK" sections all in the Yocto Project Overview and Concepts Manual. @@ -3373,7 +3373,7 @@ do_package_write_deb task writes Debian packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -3403,9 +3403,9 @@ section. For more detail on the contents of the deploy directory, see the - "Images" + "Images" and - "Application Development SDK" + "Application Development SDK" sections both in the Yocto Project Overview and Concepts Manual. @@ -3445,7 +3445,7 @@ do_package_write_ipk task writes IPK packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -3484,7 +3484,7 @@ do_package_write_rpm task writes RPM packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -3523,7 +3523,7 @@ do_package_write_tar task writes TAR packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" + "Package Feeds" section in the Yocto Project Overview and Concepts Manual. @@ -4865,7 +4865,7 @@ The previous statement appears in the linux-yocto-dev.bbappend file, which is found in the Yocto Project - Source Repositories + Source Repositories in meta-intel/common/recipes-kernel/linux. Here, the machine override is a special @@ -6106,7 +6106,7 @@ variables. You can find information on how the image is created in the - "Image Generation" + "Image Generation" section in the Yocto Project Overview and Concepts Manual. @@ -7980,7 +7980,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" LICENSE is set to "CLOSED"). For more information, see the - "Tracking License Changes" + "Tracking License Changes" section in the Yocto Project Overview and Concepts Manual. @@ -8116,7 +8116,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" require additional licenses in order to be used in a commercial product. For more information, see the - "Enabling Commercially Licensed Recipes" + "Enabling Commercially Licensed Recipes" section in the Yocto Project Overview and Concepts Manual. @@ -8136,7 +8136,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This practice is otherwise known as "whitelisting" license flags. For more information, see the - Enabling Commercially Licensed Recipes" + Enabling Commercially Licensed Recipes" section in the Yocto Project Overview and Concepts Manual. @@ -10490,7 +10490,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" ${STAGING_DIR_HOST}/pkgdata For examples of how this data is used, see the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual and the "Viewing Package Information with oe-pkgdata-util" @@ -10738,11 +10738,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PR to know when to rebuild a recipe. The build system uses the task - input checksums + input checksums along with the stamp and - shared state cache + shared state cache mechanisms. The PR variable primarily becomes @@ -11011,7 +11011,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For more information, see the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual. @@ -11328,7 +11328,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Therefore, most recipes do not need to set RDEPENDS. For more information, see the - "Automatically Added Runtime Dependencies" + "Automatically Added Runtime Dependencies" section in the Yocto Project Overview and Concepts Manual. @@ -13848,7 +13848,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For information on how BitBake uses stamp files to determine if a task should be rerun, see the - "Stamp Files and the Rerunning of Tasks" + "Stamp Files and the Rerunning of Tasks" section in the Yocto Project Overview and Concepts Manual. @@ -15340,7 +15340,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For background information on cross-development toolchains in the Yocto Project development environment, see the - "Cross-Development Toolchain Generation" + "Cross-Development Toolchain Generation" section in the Yocto Project Overview and Concepts Manual. For information on setting up a cross-development environment, see the @@ -15399,7 +15399,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For background information on cross-development toolchains in the Yocto Project development environment, see the - "Cross-Development Toolchain Generation" + "Cross-Development Toolchain Generation" section in the Yocto Project Overview and Concepts Manual. For information on setting up a cross-development environment, see the diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml index 52c64d460e..8d9ca34d0a 100644 --- a/documentation/ref-manual/resources.xml +++ b/documentation/ref-manual/resources.xml @@ -168,7 +168,7 @@ - Yocto Project Overview and Concepts Manual: + Yocto Project Overview and Concepts Manual: This manual provides overview and conceptual information about the Yocto Project. @@ -216,7 +216,7 @@ - Yocto Project Reference Mega-Manual: + Yocto Project Mega-Manual: This manual is simply a single HTML file comprised of the bulk of the Yocto Project manuals. diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml index ffdc3063b6..ac461e62dd 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.xml +++ b/documentation/sdk-manual/sdk-appendix-obtain.xml @@ -327,7 +327,7 @@ Following is an example command that extracts the root filesystem from a previously built root filesystem image that was downloaded from the - Index of Releases. + Index of Releases. This command extracts the root filesystem into the core2-64-sato directory: diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 246b5eae84..4303054cba 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -247,7 +247,7 @@ The devtool command line is organized similarly to - Git in that it + Git in that it has a number of sub-commands for each function. You can run devtool --help to see all the commands. diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index ae4e95a472..03ab35fc99 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml @@ -92,7 +92,7 @@ For general information on layers, see the - "The Yocto Project Layer Model" + "The Yocto Project Layer Model" section in the Yocto Project Overview and Concepts Manual. For information on how to create layers, see the "Understanding and Creating Layers" -- cgit v1.2.3-54-g00ecf