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/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 +- 11 files changed, 64 insertions(+), 64 deletions(-) (limited to 'documentation/ref-manual') 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. -- cgit v1.2.3-54-g00ecf