From 2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 16 Oct 2014 16:31:19 -0700 Subject: ref-manual: Scrubbed for variable (user) input. Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 132 +++++++++++++++-------------- 1 file changed, 68 insertions(+), 64 deletions(-) (limited to 'documentation/ref-manual/ref-variables.xml') diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index aadae01ac4..1aabd5c71d 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -136,7 +136,7 @@ If ALTERNATIVE_LINK_NAME is not defined, it defaults to - ${bindir}/<name>. + ${bindir}/name. @@ -159,9 +159,9 @@ a default for specific commands tied to particular packages. Here are the available syntax forms: - ALTERNATIVE_PRIORITY = "<priority>" - ALTERNATIVE_PRIORITY[<name>] = "<priority>" - ALTERNATIVE_PRIORITY_<pkg>[<name>] = "<priority>" + ALTERNATIVE_PRIORITY = "priority" + ALTERNATIVE_PRIORITY[name] = "priority" + ALTERNATIVE_PRIORITY_pkg[name] = "priority" @@ -185,9 +185,9 @@ a default for specific commands tied to particular packages. Here are the available syntax forms: - ALTERNATIVE_TARGET = "<target>" - ALTERNATIVE_TARGET[<name>] = "<target>" - ALTERNATIVE_TARGET_<pkg>[<name>] = "<target>" + ALTERNATIVE_TARGET = "target" + ALTERNATIVE_TARGET[name] = "target" + ALTERNATIVE_TARGET_pkg[name] = "target" @@ -338,13 +338,13 @@ being installed by listing them with the BAD_RECOMMENDATIONS variable: - BAD_RECOMMENDATIONS = "<package_name> <package_name> <package_name> ..." + BAD_RECOMMENDATIONS = "package_name package_name package_name ..." You can set this variable globally in your local.conf file or you can attach it to a specific image recipe by using the recipe name override: - BAD_RECOMMENDATIONS_pn-<target_image> = "<package_name>" + BAD_RECOMMENDATIONS_pn-target_image = "package_name" @@ -445,11 +445,11 @@ Build Directory. Use the following form: - BB_DISKMON_DIRS = "<action>,<dir>,<threshold> [...]" + BB_DISKMON_DIRS = "action,dir,threshold [...]" where: - <action> is: + action is: ABORT: Immediately abort the build when a threshold is broken. STOPTASKS: Stop the build after the currently @@ -463,14 +463,14 @@ which must be defined in the conf/local.conf file. - <dir> is: + dir is: Any directory you choose. You can specify one or more directories to monitor by separating the groupings with a space. If two directories are on the same device, only the first directory is monitored. - <threshold> is: + threshold is: Either the minimum available disk space, the minimum number of free inodes, or both. You must specify at least one. To @@ -559,16 +559,16 @@ When specifying the variable in your configuration file, use the following form: - BB_DISKMON_WARNINTERVAL = "<disk_space_interval>,<disk_inode_interval>" + BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval" where: - <disk_space_interval> is: + disk_space_interval is: An interval of memory expressed in either G, M, or K for Gbytes, Mbytes, or Kbytes, respectively. You cannot use GB, MB, or KB. - <disk_inode_interval> is: + disk_inode_interval is: An interval of free inodes expressed in either G, M, or K for Gbytes, Mbytes, or Kbytes, respectively. You cannot use GB, MB, or KB. @@ -643,7 +643,7 @@ which is a compiler built to run on the build machine but produces binaries that run on the target MACHINE; "nativesdk", which targets the SDK machine instead of MACHINE; - and "mulitlibs" in the form "multilib:<multilib_name>". + and "mulitlibs" in the form "multilib:multilib_name". @@ -651,7 +651,7 @@ is as simple as adding the following to your recipe: BBCLASSEXTEND =+ "native nativesdk" - BBCLASSEXTEND =+ "multilib:<multilib_name>" + BBCLASSEXTEND =+ "multilib:multilib_name" @@ -856,9 +856,9 @@ Set the variable as you would any environment variable and then run BitBake: - $ BBPATH = "<build_directory>" + $ BBPATH = "build_directory" $ export BBPATH - $ bitbake <target> + $ bitbake target @@ -2241,7 +2241,7 @@ you want the error reporting tool to store the debug files as follows in your local.conf file: - ERR_REPORT_DIR = "path" + ERR_REPORT_DIR = "path" @@ -2585,11 +2585,11 @@ should have the name of the feature item as an override. Here is an example: - FEATURE_PACKAGES_widget = "package1 package2" + FEATURE_PACKAGES_widget = "package1 package2" In this example, if "widget" were added to - IMAGE_FEATURES, "package1" and - "package2" would be included in the image. + IMAGE_FEATURES, package1 and + package2 would be included in the image. Packages installed by features defined through FEATURE_PACKAGES are often package @@ -3468,7 +3468,7 @@ When you use this variable, it is best to use it as follows: - IMAGE_INSTALL_append = " package-name" + IMAGE_INSTALL_append = " package-name" Be sure to include the space between the quotation character and the start of the package name or names. @@ -3520,7 +3520,7 @@ The file contains package information on a line-per-package basis as follows: - <packagename> <packagearch> <version> + packagename packagearch version @@ -3653,7 +3653,7 @@ OpenEmbedded build system has created the image. You can specify shell commands separated by semicolons: - IMAGE_POSTPROCESS_COMMAND += "<shell_command>; ... " + IMAGE_POSTPROCESS_COMMAND += "shell_command; ... " If you need to pass the path to the root filesystem within the command, you can use @@ -4458,7 +4458,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Specify it as follows: - KERNEL_MODULE_AUTOLOAD += "modname1 modname2 modname3" + KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3" @@ -4470,7 +4470,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The modules appear one-per-line in the file. Here is an example of the most common use case: - KERNEL_MODULE_AUTOLOAD += "modname" + KERNEL_MODULE_AUTOLOAD += "module_name" @@ -4489,7 +4489,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Provides a list of modules for which the OpenEmbedded build system expects to find - module_conf_<modname> + module_conf_modname values that specify configuration for each of the modules. For information on how to provide those module configurations, see the @@ -4505,7 +4505,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR - within the module.bbclass class. + within the + module + class. For information on how this variable is used, see the "Incorporating Out-of-Tree Modules" section. @@ -4530,7 +4532,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR - within the module.bbclass class. + within the + module + class. For information on how this variable is used, see the "Incorporating Out-of-Tree Modules" section. @@ -4796,10 +4800,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This variable must be defined for all recipes (unless LICENSE - is set to "CLOSED") + is set to "CLOSED"). For more information, see the - - Tracking License Changes section + " + Tracking License Changes" section. @@ -4912,7 +4916,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The LICENSE_PATH variable allows you to extend that location to other areas that have additional licenses: - LICENSE_PATH += "/path/to/additional/common/licenses" + LICENSE_PATH += "path-to-additional-common-licenses" @@ -5407,7 +5411,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Here is the general syntax: - module_conf_<modname> = "<modprobe.d syntax>" + module_conf_module_name = "modprobe.d-syntax" You must use the kernel module name override. @@ -5531,7 +5535,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" local.conf file or you can attach it to a specific image recipe by using the recipe name override: - NO_RECOMMENDATIONS_pn-<target_image> = "<package_name>" + NO_RECOMMENDATIONS_pn-target_image = "package_name" @@ -5909,13 +5913,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Lists packages that should not be installed into an image. For example: - PACKAGE_EXCLUDE = "<package_name> <package_name> <package_name> ..." + PACKAGE_EXCLUDE = "package_name package_name package_name ..." You can set this variable globally in your local.conf file or you can attach it to a specific image recipe by using the recipe name override: - PACKAGE_EXCLUDE_pn-<target_image> = "<package_name>" + PACKAGE_EXCLUDE_pn-target_image = "package_name" @@ -6099,8 +6103,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Append file: Create an append file named - <recipename>.bbappend in your - layer and override the value of + recipename.bbappend + in your layer and override the value of PACKAGECONFIG. You can either completely override the variable: @@ -6114,15 +6118,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This method is identical to changing the block through an append file except you edit your local.conf or - <mydistro>.conf file. + mydistro.conf file. As with append files previously described, you can either completely override the variable: - PACKAGECONFIG_pn-<recipename>="f4 f5" + PACKAGECONFIG_pn-recipename="f4 f5" Or, you can just amend the variable: - PACKAGECONFIG_append_pn-<recipename> = " f4" + PACKAGECONFIG_append_pn-recipename = " f4" @@ -6345,7 +6349,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For example, when the debian class renames the output package, it does so by setting - PKG_<packagename>. + PKG_packagename. @@ -6868,7 +6872,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" them in conjunction with a package name override. Here is an example: - RCONFLICTS_${PN} = "another-conflicting-package-name" + RCONFLICTS_${PN} = "another-conflicting-package-name" @@ -6880,7 +6884,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Here is the general syntax to specify versions with the RCONFLICTS variable: - RCONFLICTS_${PN} = "<package> (<operator> <version>)" + RCONFLICTS_${PN} = "package (operator version)" For operator, you can specify the following: @@ -6972,7 +6976,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" as it would in the PACKAGES namespace before any renaming of the output package by classes like - debian.bbclass. + debian. @@ -7006,7 +7010,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Here is the general syntax to specify versions with the RDEPENDS variable: - RDEPENDS_${PN} = "<package> (<operator> <version>)" + RDEPENDS_${PN} = "package (operator version)" For operator, you can specify the following: @@ -7136,7 +7140,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" OpenEmbedded build system has created the root filesystem. You can specify shell commands separated by semicolons: - ROOTFS_POSTPROCESS_COMMAND += "<shell_command>; ... " + ROOTFS_POSTPROCESS_COMMAND += "shell_command; ... " If you need to pass the path to the root filesystem within the command, you can use @@ -7224,7 +7228,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" that is extended to support wireless functionality. In this case, you would use the following: - RRECOMMENDS_${PN}-dev += "<wireless_package_name>" + RRECOMMENDS_${PN}-dev += "wireless_package_name" In the example, the package name (${PN}-dev) @@ -7242,7 +7246,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Here is the general syntax to specify versions with the RRECOMMENDS variable: - RRECOMMENDS_${PN} = "<package> (<operator> <version>)" + RRECOMMENDS_${PN} = "package (operator version)" For operator, you can specify the following: @@ -7280,7 +7284,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" override. Here is an example: - RREPLACES_${PN} = "other-package-being-replaced" + RREPLACES_${PN} = "other-package-being-replaced" @@ -7292,7 +7296,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Here is the general syntax to specify versions with the RREPLACES variable: - RREPLACES_${PN} = "<package> (<operator> <version>)" + RREPLACES_${PN} = "package (operator version)" For operator, you can specify the following: @@ -7327,7 +7331,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" override. Here is an example: - RSUGGESTS_${PN} = "useful-package another-package" + RSUGGESTS_${PN} = "useful-package another-package" @@ -7503,7 +7507,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" However, this variable applies to the SDK generated from an image using the following command: - $ bitbake -c populate_sdk imagename + $ bitbake -c populate_sdk imagename @@ -8083,8 +8087,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" directory structure. SSTATE_MIRRORS ?= "\ - file://.* http://someserver.tld/share/sstate/PATH \n \ - file://.* file:///some/local/dir/sstate/PATH" + file://.* http://someserver.tld/share/sstate/PATH \n \ + file://.* file:///some-local-dir/sstate/PATH" @@ -9090,7 +9094,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" You can add your own tests to the list of tests by appending TEST_SUITES as follows: - TEST_SUITES_append = " mytest" + TEST_SUITES_append = " mytest" Alternatively, you can provide the "auto" option to have all applicable tests run against the image. @@ -9511,11 +9515,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - TUNECONFLICT[<feature>] + TUNECONFLICT[feature] Specifies CPU or Application Binary Interface (ABI) - tuning features that conflict with >feature<. + tuning features that conflict with feature. @@ -9533,7 +9537,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - TUNEVALID[<feature>] + TUNEVALID[feature] Specifies a valid CPU or Application Binary Interface (ABI) @@ -9644,7 +9648,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The value indicates the target platform configuration. You typically set this variable from the machine configuration file (i.e. - conf/machine/<machine_name>.conf). + conf/machine/machine_name.conf). -- cgit v1.2.3-54-g00ecf