From ae06e04cd225d2c2147ca355e2dd39b4f6cf6775 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 29 Jan 2018 15:18:03 -0800 Subject: documentation: Created new "Getting Started" manual. Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) 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-bitbake.xml | 2 +- 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 | 2 +- documentation/ref-manual/ref-tasks.xml | 34 +++++++-------- documentation/ref-manual/ref-terms.xml | 4 +- documentation/ref-manual/ref-variables.xml | 50 +++++++++++----------- documentation/ref-manual/resources.xml | 2 +- 12 files changed, 63 insertions(+), 63 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index ddb5078454..ecc866cdb3 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 Manual and also in the "Maintaining Open Source License Compliance During Your Product's Lifecycle" section in the Yocto Project Development Tasks Manual. diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 01c5a982e2..bccbeed3b9 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-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml index 7d1dd48128..e848de81b3 100644 --- a/documentation/ref-manual/ref-bitbake.xml +++ b/documentation/ref-manual/ref-bitbake.xml @@ -350,7 +350,7 @@ checksums. For information on this process, see the BB_HASHBASE_WHITELIST example in the - "Checksums (Signatures)" + "Checksums (Signatures)" section in the Yocto Project Overview Manual. diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 3b7ac31e6a..39d740d7d4 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 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 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 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 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 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 Manual. diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml index fd6d5aabe9..58f33cda2a 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 Manual. core-image-x11: diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml index 1b36932e21..d8ead1399b 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 7a2371d8b3..1dff8f81f9 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 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 Manual. diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml index baeb116a26..4e4e0de514 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 Manual. diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 4fa64c0d60..262dec8311 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 Manual. @@ -246,7 +246,7 @@ For more information on image creation, see the - "Image Generation" + "Image Generation" section in the Yocto Project Overview 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 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 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 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 Manual. @@ -408,7 +408,7 @@ ${DEPLOY_DIR_TAR} directory in the package feeds area. For more information, see the - "Package Feeds" + "Package Feeds" section Yocto Project Overview 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 Manual for more information. @@ -451,7 +451,7 @@ Creates the file and directory structure for an installable SDK. See the - "SDK Generation" + "SDK Generation" section in the Yocto Project Overview Manual for more information. @@ -538,7 +538,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 Manual and also see the WORKDIR and S variable descriptions. @@ -628,7 +628,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 @@ -645,7 +645,7 @@ Removes all output files, shared state - (sstate) + (sstate) cache, and downloaded source files for a target (i.e. the contents of DL_DIR). @@ -676,13 +676,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. @@ -760,7 +760,7 @@ Creates or updates the index in the - Package Feeds + Package Feeds area. This task is not triggered with the @@ -812,7 +812,7 @@ Creates the root filesystem (file and directory structure) for an image. See the - "Image Generation" + "Image Generation" section in the Yocto Project Overview 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 237e765202..9e38e98693 100644 --- a/documentation/ref-manual/ref-terms.xml +++ b/documentation/ref-manual/ref-terms.xml @@ -181,7 +181,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 Manual. You can also find more information on using the relocatable toolchain in the @@ -399,7 +399,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 Manual. Task: diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 334336880b..f09e0b6ae4 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 Manual, runtime dependencies will often be added automatically, meaning @@ -3329,11 +3329,11 @@ section. For more detail on the contents of the deploy directory, see the - "Images" + "Images" section, the - "Package Feeds" + "Package Feeds" section, and the - "Application Development SDK" + "Application Development SDK" sections all in the Yocto Project Overview 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 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 Manual. @@ -3444,7 +3444,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 Manual. @@ -3483,7 +3483,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. @@ -3522,7 +3522,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 Manual. @@ -4864,7 +4864,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 @@ -6084,7 +6084,7 @@ variables. You can find information on how the image is created in the - "Image Generation" + "Image Generation" section in the Yocto Project Overview Manual. @@ -7911,7 +7911,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 Manual. @@ -8047,7 +8047,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 Manual. @@ -8067,7 +8067,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 Manual. @@ -10412,7 +10412,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 Manual and the "Viewing Package Information with oe-pkgdata-util" section in the Yocto Project Development Tasks Manual. @@ -10659,11 +10659,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 @@ -10715,7 +10715,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PREFERRED_PROVIDER_virtual/libgl ?= "mesa" For more information, see the - "Metadata (Virtual Providers)" + "Metadata (Virtual Providers)" section in the Yocto Project Overview Manual. If you set PREFERRED_PROVIDER @@ -10919,7 +10919,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 Manual. @@ -11236,7 +11236,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 Manual. @@ -13695,7 +13695,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 Manual. @@ -15187,7 +15187,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 Manual. For information on setting up a cross-development environment, see the @@ -15246,7 +15246,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 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 3076de2e5e..09feddd29f 100644 --- a/documentation/ref-manual/resources.xml +++ b/documentation/ref-manual/resources.xml @@ -167,7 +167,7 @@ - Yocto Project Overview Manual: + Yocto Project Overview Manual: This manual introduces the Yocto Project, provides development environment basics, and explains Yocto Project concepts. -- cgit v1.2.3-54-g00ecf