From 982cce2d2cd4ca7dcbc8d868d70fce2b6d264e36 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 10 Apr 2018 12:04:20 -0700 Subject: documentation: Fixed links to old concepts-manual The concepts-manual is going away for 2.5. I have fixed all the links across the YP documentation set that were cross-referencing into the concepts-manual so they now cross-reference into the getting-started manual, where that concepts chapter will live post 2.4x. (From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.xml | 7 +- .../dev-manual/dev-manual-common-tasks.xml | 42 ++++++----- documentation/dev-manual/dev-manual-start.xml | 4 +- .../getting-started/getting-started-concepts.xml | 2 +- .../getting-started/getting-started-yp-intro.xml | 9 ++- documentation/ref-manual/ref-classes.xml | 28 +++---- documentation/ref-manual/ref-images.xml | 4 +- documentation/ref-manual/ref-structure.xml | 10 +-- documentation/ref-manual/ref-tasks.xml | 56 +++++++------- documentation/ref-manual/ref-terms.xml | 4 +- documentation/ref-manual/ref-variables.xml | 87 +++++++++++----------- 11 files changed, 131 insertions(+), 122 deletions(-) (limited to 'documentation') diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 771f58c079..297478d656 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -1687,9 +1687,10 @@ Thus, the build system can build the corresponding recipe and include the component in the image. See the - "Enabling Commercially Licensed Recipes" - section in the Yocto Project Concepts Manual for - details on how to use these variables. + "Enabling Commercially Licensed Recipes" + section in the Yocto Project Overview and Concepts + Manual for details on how to use these variables. + If you build as you normally would, without specifying any recipes in the diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 50e60ba11b..d273eaedd9 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1872,8 +1872,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Sources" + section in the Yocto Project Overview and Concepts Manual. @@ -2185,8 +2185,10 @@ containing the current checksum. For more explanation and examples of how to set the LIC_FILES_CHKSUM variable, see the - "Tracking License Changes" - section in the Yocto Project Concepts Manual. + "Tracking License Changes" + section in the Yocto Project Overview and Concepts + Manual. + To determine the correct checksum string, you can list the appropriate files in the LIC_FILES_CHKSUM variable with @@ -2332,9 +2334,9 @@ automatically add a runtime dependency to "mypackage" on "example"). See the - "Automatically Added Runtime Dependencies" - section in the Yocto Project Concepts Manual for further - details. + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and Concepts Manual for + further details. @@ -3396,9 +3398,10 @@ The variable LIC_FILES_CHKSUM is used to track source license changes as described in the - "Tracking License Changes" - section in the Yocto Project Concepts Manual. - You can quickly create Autotool-based recipes in a manner similar to the previous example. + "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. @@ -3603,9 +3606,9 @@ allows runtime dependencies between packages to be added automatically. See the - "Automatically Added Runtime Dependencies" - section in the Yocto Project Concepts Manual - for more information. + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and + Concepts Manual for more information. @@ -8503,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 @@ -8607,8 +8610,9 @@ Some notes from Cal: For more information on shared state, see the - "Shared State Cache" - section in the Yocto Project Concepts Manual. + "Shared State Cache" + section in the Yocto Project Overview and Concepts + Manual. @@ -12257,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 @@ -12366,8 +12370,8 @@ 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" - section in the Yocto Project Concepts Manual for + "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-start.xml b/documentation/dev-manual/dev-manual-start.xml index e0d36e95e4..30fdb6be5c 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -748,8 +748,8 @@ Build Directory under tmp/deploy/images. For detailed information on the build process using BitBake, see the - "Images" - section in the Yocto Project Concepts Manual. + "Images" + section in the Yocto Project Overview and Concepts Manual. diff --git a/documentation/getting-started/getting-started-concepts.xml b/documentation/getting-started/getting-started-concepts.xml index bdaa0ead5e..a534deafee 100644 --- a/documentation/getting-started/getting-started-concepts.xml +++ b/documentation/getting-started/getting-started-concepts.xml @@ -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/getting-started/getting-started-yp-intro.xml b/documentation/getting-started/getting-started-yp-intro.xml index d98aacc6f1..437635842a 100644 --- a/documentation/getting-started/getting-started-yp-intro.xml +++ b/documentation/getting-started/getting-started-yp-intro.xml @@ -654,8 +654,9 @@ when they do not. You can read more about Pseudo in the - "Fakeroot and Pseudo" - section of the Yocto Project Concepts Manual. + "Fakeroot and Pseudo" + section of the Yocto Project Overview and Concepts + Manual. @@ -1142,8 +1143,8 @@ For a very detailed look at this workflow, see the - "Development Concepts" - section in the Yocto Project Concepts Manual. + "Development Concepts" + section in the Yocto Project Overview and Concepts Manual. diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 8dfa0851cd..53c06354a6 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -568,9 +568,9 @@ provides support for the recipes that build the Canadian Cross-compilation tools for SDKs. See the - "Cross-Development Toolchain Generation" - section in the Yocto Project Concepts Manual for more discussion on - these cross-compilation tools. + "Cross-Development Toolchain Generation" + section in the Yocto Project Overview and Concepts Manual for more + discussion on these cross-compilation tools. @@ -582,9 +582,9 @@ provides support for the recipes that build the cross-compilation tools used for building SDKs. See the - "Cross-Development Toolchain Generation" - section in the Yocto Project Concepts Manual for more discussion on - these cross-compilation tools. + "Cross-Development Toolchain Generation" + section in the Yocto Project Overview and Concepts Manual for more + discussion on these cross-compilation tools. @@ -1251,8 +1251,8 @@ "Customizing Images" section in the Yocto Project Development Tasks Manual. For information on how images are created, see the - "Images" - section in the Yocto Project Concpets Manual. + "Images" + section in the Yocto Project Overview and Concpets Manual. @@ -2722,8 +2722,8 @@ This check was removed for YP 2.3 release For more information on the cross-development toolchain generation, see the - "Cross-Development Toolchain Generation" - section in the Yocto Project Concepts Manual. + "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 do_populate_sdk @@ -3020,8 +3020,8 @@ This check was removed for YP 2.3 release For information on how root filesystem images are created, see the - "Image Generation" - section in the Yocto Project Concepts Manual. + "Image Generation" + section in the Yocto Project Overview and Concepts Manual. @@ -3182,8 +3182,8 @@ This check was removed for YP 2.3 release For more information on sstate, see the - "Shared State Cache" - section in the Yocto Project Concepts Manual. + "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 8b7cee827a..0cfa5f3543 100644 --- a/documentation/ref-manual/ref-images.xml +++ b/documentation/ref-manual/ref-images.xml @@ -151,8 +151,8 @@ This image provides the Wayland protocol libraries and the reference Weston compositor. For more information, see the - "Wayland" - section in the Yocto Project Concepts Manual. + "Wayland" + section in the Yocto Project Overview and Concepts Manual. core-image-x11: A very basic X11 image with a terminal. diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 56f786c21e..07f4e7c490 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -520,10 +520,10 @@ variable points to this directory. For more detail on the contents of the deploy directory, see the - "Images" + "Images" and - "Application Development SDK" - sections in the Yocto Project Concepts Manual. + "Application Development SDK" + sections in the Yocto Project Overview and Concepts Manual. @@ -696,8 +696,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Stamp Files and the Rerunning of Tasks" + section in the Yocto Project Overview and Concepts Manual. diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 2a58f955b0..3226b17299 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -220,8 +220,8 @@ For more information on image creation, see the - "Image Generation" - section in the Yocto Project Concepts Manual. + "Image Generation" + section in the Yocto Project Overview and Concepts Manual. @@ -246,8 +246,8 @@ For more information on image creation, see the - "Image Generation" - section in the Yocto Project Concepts Manual. + "Image Generation" + section in the Yocto Project Overview and Concepts Manual. @@ -268,7 +268,7 @@ and do_rootfs), run under - fakeroot. + fakeroot. Caution @@ -342,8 +342,8 @@ For additional information, see the PKGDESTWORK variable and the - "Automatically Added Runtime Dependencies" - section in the Yocto Project Concepts Manual. + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and Concepts Manual. @@ -367,8 +367,8 @@ ${DEPLOY_DIR_DEB} directory in the package feeds area. For more information, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -381,8 +381,8 @@ ${DEPLOY_DIR_IPK} directory in the package feeds area. For more information, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -395,8 +395,8 @@ ${DEPLOY_DIR_RPM} directory in the package feeds area. For more information, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -408,8 +408,8 @@ ${DEPLOY_DIR_TAR} directory in the package feeds area. For more information, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -431,8 +431,8 @@ Locates patch files and applies them to the source code. See the - "Patching" - section in the Yocto Project Concepts Manual for more + "Patching" + section in the Yocto Project Overview and Concepts Manual for more information. @@ -452,8 +452,8 @@ Creates the file and directory structure for an installable SDK. See the - "SDK Generation" - section in the Yocto Project Concepts Manual for more + "SDK Generation" + section in the Yocto Project Overview and Concepts Manual for more information. @@ -540,8 +540,8 @@ 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" - section in the Yocto Project Concepts Manual and also + "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,8 +796,8 @@ Creates the root filesystem (file and directory structure) for an image. See the - "Image Generation" - section in the Yocto Project Concepts Manual for more + "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 0984503b8c..aebd6e2ba2 100644 --- a/documentation/ref-manual/ref-terms.xml +++ b/documentation/ref-manual/ref-terms.xml @@ -200,8 +200,8 @@ 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" - section in the Yocto Project Concepts Manual. + "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 Yocto Project Application Development and the Extensible Software Development Kit (eSDK) diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 76194d450b..01bbc1c473 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,10 +3264,10 @@ add any runtime dependencies between the packages produced by the two recipes. However, as explained in the - "Automatically Added Runtime Dependencies" - section in the Yocto Project Concepts Manual, - runtime dependencies will often be - added automatically, meaning + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and + Concepts Manual, runtime dependencies will + often be added automatically, meaning DEPENDS alone is sufficient for most recipes. @@ -3329,11 +3329,12 @@ section. For more detail on the contents of the deploy directory, see the - "Images", - "Package Feeds", + "Images", + "Package Feeds", and - "Application Development SDK" - sections all in the Yocto Project Concepts Manual. + "Application Development SDK" + sections all in the Yocto Project Overview and Concepts + Manual. @@ -3372,8 +3373,8 @@ do_package_write_deb task writes Debian packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -3402,10 +3403,11 @@ section. For more detail on the contents of the deploy directory, see the - "Images" + "Images" and - "Application Development SDK" - sections both in the Yocto Project Concepts Manual. + "Application Development SDK" + sections both in the Yocto Project Overview and Concepts + Manual. @@ -3443,8 +3445,8 @@ do_package_write_ipk task writes IPK packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -3482,8 +3484,8 @@ do_package_write_rpm task writes RPM packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -3521,8 +3523,8 @@ do_package_write_tar task writes TAR packages into the appropriate folder. For more information on how packaging works, see the - "Package Feeds" - section in the Yocto Project Concepts Manual. + "Package Feeds" + section in the Yocto Project Overview and Concepts Manual. @@ -6104,8 +6106,8 @@ variables. You can find information on how the image is created in the - "Image Generation" - section in the Yocto Project Concepts Manual. + "Image Generation" + section in the Yocto Project Overview and Concepts Manual. @@ -7978,8 +7980,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Tracking License Changes" + section in the Yocto Project Overview and Concepts Manual. @@ -8114,8 +8116,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Enabling Commercially Licensed Recipes" + section in the Yocto Project Overview and Concepts Manual. @@ -8134,8 +8136,8 @@ 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" - section in the Yocto Project Concepts Manual. + Enabling Commercially Licensed Recipes" + section in the Yocto Project Overview and Concepts Manual. @@ -10488,8 +10490,9 @@ 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" - section in the Yocto Project Concepts Manual and the + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and Concepts Manual + and the "Viewing Package Information with oe-pkgdata-util" section in the Yocto Project Development Tasks Manual. @@ -10735,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 @@ -11008,8 +11011,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For more information, see the - "Automatically Added Runtime Dependencies" - section in the Yocto Project Concepts Manual. + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and Concepts Manual. @@ -11325,8 +11328,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Automatically Added Runtime Dependencies" + section in the Yocto Project Overview and Concepts Manual. @@ -13845,8 +13848,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Stamp Files and the Rerunning of Tasks" + section in the Yocto Project Overview and Concepts Manual. @@ -15337,8 +15340,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Cross-Development Toolchain Generation" + section in the Yocto Project Overview and Concepts Manual. For information on setting up a cross-development environment, see the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) @@ -15396,8 +15399,8 @@ 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" - section in the Yocto Project Concepts Manual. + "Cross-Development Toolchain Generation" + section in the Yocto Project Overview and Concepts Manual. For information on setting up a cross-development environment, see the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) -- cgit v1.2.3-54-g00ecf