diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index f1f7644b81..bec6caed34 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -321,7 +321,7 @@ For information on how the variable works, see the meta/classes/archiver.bbclass file in the - Source Directory. + Source Directory. @@ -488,7 +488,7 @@ For more information see the "Automatically Incrementing a Binary Package Revision Number" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -626,14 +626,14 @@ Multilib context. See the "Combining Multiple Versions of Library Files into One Image" - section in the Yocto Project Development Manual for + section in the Yocto Project Development Tasks Manual for information on Multilib. The BASE_LIB variable is defined in the machine include files in the - Source Directory. + Source Directory. If Multilib is not being used, the value defaults to "lib". @@ -1263,7 +1263,7 @@ supports building targets with multiple configurations, see the "Building Targets with Multiple Configurations" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -1374,7 +1374,7 @@ For more information on how this variable works, see meta/classes/binconfig.bbclass in the - Source Directory. + Source Directory. You can also find general information on the class in the "binconfig.bbclass" section. @@ -2073,7 +2073,7 @@ Specifies the directory BitBake uses to store a cache of the - Metadata + Metadata so it does not need to be parsed every time BitBake is started. @@ -2231,7 +2231,7 @@ Points to meta/files/common-licenses in the - Source Directory, + Source Directory, which is where generic license files reside. @@ -2398,7 +2398,7 @@ than /usr/bin. You can find a list of these variables at the top of the meta/conf/bitbake.conf file in the - Source Directory. + Source Directory. @@ -2441,7 +2441,7 @@ For information on creating an initramfs, see the "Building an Initial RAM Filesystem (initramfs) Image" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -2675,8 +2675,8 @@ variable for additional information. You can also reference the "Providing License Text" - section in the Yocto Project Development Manual for - information on providing license text. + section in the Yocto Project Development Tasks Manual + for information on providing license text. @@ -2703,8 +2703,8 @@ variable for additional information. You can also reference the "Providing License Text" - section in the Yocto Project Development Manual for - information on providing license text. + section in the Yocto Project Development Tasks Manual + for information on providing license text. @@ -3566,7 +3566,7 @@ and resides in the meta-poky/conf/distro directory of the - Source Directory. + Source Directory. @@ -3580,7 +3580,7 @@ Distribution configuration files are located in a conf/distro directory within the - Metadata + Metadata that contains the distribution configuration. The value for DISTRO must not contain spaces, and is typically all lower-case. @@ -4244,7 +4244,7 @@ You can also find information on how to use this variable in the "Building Software from an External Source" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -4275,7 +4275,7 @@ You can also find information on how to use this variable in the "Building Software from an External Source" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -4352,8 +4352,8 @@ filesystem is read-only. See the "Creating a Read-Only Root Filesystem" section in the Yocto Project - Development Manual for more - information + Development Tasks Manual for + more information "tools-debug" - Adds debugging tools such as gdb and strace. @@ -4379,7 +4379,7 @@ For an example that shows how to customize your image by using this variable, see the "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -4668,7 +4668,7 @@ /usr/bin. You can find a list of these variables at the top of the meta/conf/bitbake.conf file in the - Source Directory. + Source Directory. You will also find the default values of the various FILES_* variables in this file. @@ -4860,7 +4860,7 @@ The default value for the FILESPATH variable is defined in the base.bbclass class found in meta/classes in the - Source Directory: + Source Directory: FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" @@ -4906,7 +4906,7 @@ By default, the OpenEmbedded build system uses the fs-perms.txt, which is located in the meta/files folder in the - Source Directory. + Source Directory. If you create your own file permissions setting table, you should place it in your layer or the distro's layer. @@ -5692,7 +5692,7 @@ For more information, see meta/classes/image_types.bbclass in the - Source Directory. + Source Directory. @@ -5786,7 +5786,7 @@ For an example that shows how to customize your image by using this variable, see the "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -5856,7 +5856,7 @@ not be affected by IMAGE_INSTALL. For information on creating an initramfs, see the "Building an Initial RAM Filesystem (initramfs) Image" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -6362,7 +6362,7 @@ For more information about these types of images, see meta/classes/image_types*.bbclass in the - Source Directory. + Source Directory. @@ -6605,7 +6605,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The default value of this variable, which is set in the meta/conf/bitbake.conf configuration file in the - Source Directory, + Source Directory, is "cpio.gz". The Linux kernel's initramfs mechanism, as opposed to the initial RAM filesystem @@ -6645,7 +6645,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" See the meta/recipes-core/images/core-image-minimal-initramfs.bb recipe in the - Source Directory + Source Directory for an example initramfs recipe. To select this sample recipe as the one built to provide the initramfs image, @@ -6658,7 +6658,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" You can also find more information by referencing the meta-poky/conf/local.conf.sample.extended configuration file in the - Source Directory, + Source Directory, the image class, and the @@ -6680,7 +6680,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Additionally, for information on creating an initramfs image, see the "Building an Initial RAM Filesystem (initramfs) Image" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -6747,7 +6747,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" file for additional information. Also, for information on creating an initramfs, see the "Building an Initial RAM Filesystem (initramfs) Image" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -7200,7 +7200,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Includes additional kernel metadata. In the OpenEmbedded build system, the default Board Support Packages (BSPs) - Metadata + Metadata is provided through the KMACHINE and @@ -7912,7 +7912,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" COPY_LIC_MANIFEST variable, and the "Providing License Text" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -8011,7 +8011,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" defines the search arguments used by the kernel tools to find the appropriate description within the kernel - Metadata + Metadata with which to build out the sources and configuration. @@ -8130,7 +8130,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Thus, when MACHINE is set to "qemux86" there exists the corresponding qemux86.conf machine configuration file, which can be found in the - Source Directory + Source Directory in meta/conf/machine. @@ -8994,7 +8994,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" See the meta/classes/binconfig.bbclass in the - Source Directory + Source Directory for details on how this class applies these additional sed command arguments. For general information on the @@ -9059,7 +9059,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" -c devshell command-line option). For more information, see the "Using a Development Shell" section - in the Yocto Project Development Manual. + in the Yocto Project Development Tasks Manual. @@ -9373,7 +9373,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" You can find out more about debugging using GDB by reading the "Debugging With the GNU Project Debugger (GDB) Remotely" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -9660,7 +9660,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" variable. For information on creating an initramfs, see the "Building an Initial RAM Filesystem (initramfs) Image" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -9716,7 +9716,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For information on running post-installation scripts, see the "Post-Installation Scripts" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -9983,7 +9983,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For an example of how to use the PACKAGES_DYNAMIC variable when you are splitting packages, see the "Handling Optional Module Packaging" section - in the Yocto Project Development Manual. + in the Yocto Project Development Tasks Manual. @@ -10048,7 +10048,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" the recipe as a workaround. For information on addressing race conditions, see the "Debugging Parallel Make Races" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. For single socket systems (i.e. one CPU), you should not have to override this variable to gain optimal parallelism @@ -10097,7 +10097,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" the recipe as a workaround. For information on addressing race conditions, see the "Debugging Parallel Make Races" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. + @@ -10579,7 +10580,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" cumbersome and error-prone, an automated solution exists. See the "Working With a PR Service" - section for more information. + section in the Yocto Project Development Tasks Manual + for more information. @@ -10906,7 +10908,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The conf/local.conf.sample.extended configuration file in the - Source Directory + Source Directory shows how the PRSERV_HOST variable is set: @@ -11706,7 +11708,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" As an example, assume a - Source Directory + Source Directory top-level folder named poky and a default Build Directory at poky/build. In this case, the work directory the build system uses @@ -12815,7 +12817,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" file:// - Fetches files, which are usually files shipped with the - Metadata, + Metadata, from the local machine. The path is relative to the FILESPATH @@ -13015,7 +13017,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The SRCPV variable is defined in the meta/conf/bitbake.conf configuration file in the - Source Directory + Source Directory as follows: SRCPV = "${@bb.fetch2.get_srcrev(d)}" @@ -13059,7 +13061,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" AUTOREV variable description and the "Automatically Incrementing a Binary Package Revision Number" - section, which is in the Yocto Project Development Manual. + section, which is in the Yocto Project Development + Tasks Manual. @@ -13312,7 +13315,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSROOT_DIRS variable and the "Sharing Files Between Recipes" - section for more information. + section in the Yocto Project Development Tasks Manual + for more information. Recipes should never write files directly under the STAGING_DIR directory because @@ -14219,7 +14223,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" See the meta/conf/machine/include/arm/feature-arm-thumb.inc file in the - Source Directory + Source Directory for an example. @@ -14652,7 +14656,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For more information on enabling, running, and writing these tests, see the "Performing Automated Runtime Testing" - section in the Yocto Project Development Manual and the + section in the Yocto Project Development Tasks Manual and + the "testimage*.bbclass" section. @@ -14736,7 +14741,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For more information on testing images, see the "Performing Automated Runtime Testing" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -14843,8 +14848,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Boots a QEMU image and runs the tests. See the "Enabling Runtime Tests on QEMU" - section in the Yocto Project Development Manual for - more information. + section in the Yocto Project Development Tasks + Manual for more information. "simpleremote" and "SimpleRemoteTarget": Runs the tests on target hardware that is already @@ -14876,7 +14881,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For information on running tests on hardware, see the "Enabling Runtime Tests on Hardware" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -14965,7 +14970,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For more information on testing images, see the "Performing Automated Runtime Testing" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. @@ -15019,7 +15024,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" than the default, you can uncomment and edit the following statement in the conf/local.conf file in the - Source Directory: + Source Directory: #TMPDIR = "${TOPDIR}/tmp" @@ -15201,7 +15206,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For example, the meta/conf/machine/include/mips/README file in the - Source Directory + Source Directory provides information for TUNE_ARCH specific to the mips architecture. @@ -15484,7 +15489,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Known tuning conflicts are specified in the machine include files in the - Source Directory. + Source Directory. Here is an example from the meta/conf/machine/include/mips/arch-mips.inc include file that lists the "o32" and "n64" features as @@ -15516,7 +15521,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" See the machine include files in the - Source Directory + Source Directory for these features. @@ -15853,7 +15858,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" See the "Selecting a Device Manager" - section in the Yocto Project Development Manual for + section in the Yocto Project Development Tasks Manual for information on how to use this variable. @@ -15908,7 +15913,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For more information, see meta-poky/conf/local.conf.sample in the - Source Directory. + Source Directory. @@ -16250,7 +16255,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For information on how to create a partitioned image, see the "Creating Partitioned Images Using Wic" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. For details on the kickstart file format, see the "OpenEmbedded Kickstart (.wks) Reference Chapter.