From 37ab0888a141c5c18671afa926efaa63b1f849e9 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 21 Jan 2014 17:20:55 -0600 Subject: bitbake: user-manual-ref-variables.xml: Editing pass. Corrected grammar and applied active voice where possible. Also removed several cross-reference tags to the YP manual set. (Bitbake rev: 17cbad436c97e904a04596237022e84853b10a21) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../doc/user-manual/user-manual-ref-variables.xml | 93 +++++++++++----------- 1 file changed, 47 insertions(+), 46 deletions(-) (limited to 'bitbake') diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index 0f62a8d1b7..4a3080f841 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml @@ -55,7 +55,7 @@ B - The directory in which BitBake will execute functions + The directory in which BitBake executes functions during a recipe's build process. @@ -146,7 +146,7 @@ below 1 Gbyte or the available free inodes drops below 100 Kbytes. Because two directories are provided with the variable, the - build system also issue a + build system also issues a warning when the disk space in the ${SSTATE_DIR} directory drops below 1 Gbyte or the number of free inodes drops @@ -295,7 +295,7 @@ Lists the names of configured layers. These names are used to find the other BBFILE_* variables. - Typically, each layer will append its name to this variable in its + Typically, each layer appends its name to this variable in its conf/layer.conf file. @@ -345,7 +345,7 @@ BBFILES - List of recipe files used by BitBake to build software. + List of recipe files BitBake uses to build software. @@ -435,8 +435,9 @@ BBPATH - Used by BitBake to locate - .bbclass and configuration files. + Used by BitBake to locate class + (.bbclass) and configuration + (.conf) files. This variable is analogous to the PATH variable. @@ -645,17 +646,18 @@ LAYERDEPENDS - Lists the layers that this recipe depends upon, separated by spaces. + Lists the layers, separated by spaces, upon which this recipe depends. Optionally, you can specify a specific layer version for a dependency by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" to be compared against LAYERVERSION_anotherlayer in this case). - An error will be produced if any dependency is missing or - the version numbers do not match exactly (if specified). - This variable is used in the conf/layer.conf file - and must be suffixed with the name of the specific layer (e.g. - LAYERDEPENDS_mylayer). + BitBake produces an error if any dependency is missing or + the version numbers do not match exactly (if specified). + + You use this variable in the conf/layer.conf file. + You must also use the specific layer name as a suffix + to the variable (e.g. LAYERDEPENDS_mylayer). @@ -671,13 +673,14 @@ LAYERVERSION Optionally specifies the version of a layer as a single number. - You can use this within + You can use this variable within LAYERDEPENDS for another layer in order to depend on a specific version - of the layer. - This variable is used in the conf/layer.conf file - and must be suffixed with the name of the specific layer (e.g. - LAYERVERSION_mylayer). + of the layer. + + You use this variable in the conf/layer.conf file. + You must also use the specific layer name as a suffix + to the variable (e.g. LAYERDEPENDS_mylayer). @@ -696,7 +699,7 @@ MIRRORS - Specifies additional paths from which the BitBake gets source code. + Specifies additional paths from which BitBake gets source code. When the build system searches for source code, it first tries the local download directory. If that location fails, the build system tries locations @@ -732,9 +735,9 @@ what variables are overridden after BitBake parses recipes and configuration files. You can find more information on how overrides are handled - in the BitBake Manual that is located at - bitbake/doc/manual in the - Source Directory. + in the + "Conditional Syntax (Overrides)" + section. @@ -744,7 +747,7 @@ PACKAGES - The list of packages to be created from the recipe. + The list of packages the recipe creates. @@ -759,8 +762,8 @@ they should be satisfied. For example, if a hard, runtime dependency (RDEPENDS) - of another package is satisfied - at build time through the PACKAGES_DYNAMIC + of another package is satisfied during the build + through the PACKAGES_DYNAMIC variable, but a package with the module name is never actually produced, then the other package will be broken. Thus, if you attempt to include that package in an image, @@ -775,7 +778,7 @@ The epoch of the recipe. By default, this variable is unset. - The field is used to make upgrades possible when the + The variable is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way. @@ -831,7 +834,7 @@ variable determines which recipe should be given preference. You must always suffix the variable with the PN - you want to select, and you should set the + you want to select, and you should set PV accordingly for precedence. You can use the "%" character as a @@ -870,7 +873,7 @@ - Typically, you could add a specific server for the + Typically, you would add a specific server for the build system to attempt before any others by adding something like the following to your configuration: @@ -915,14 +918,13 @@ - An example of how the PRSERV_HOST variable is + Following is an example of how the PRSERV_HOST variable is set: PRSERV_HOST = "localhost:0" You must set the variable if you want to automatically - start a local - PR service. + start a local PR service. You can set PRSERV_HOST to other values to use a remote PR service. @@ -1083,18 +1085,18 @@ to pull in for the build and how to pull them in. For example, if the recipe or append file only needs to fetch a tarball from the Internet, the recipe or - append file uses a single SRC_URI - entry. + append file uses a SRC_URI + entry that specifies just the tarball. On the other hand, if the recipe or append file needs to fetch a tarball, apply two patches, and include a custom - file, the recipe or append file would include four - instances of the variable. + file, the recipe or append file needs an + SRC_URI variable that specifies all + those sources. The following list explains the available URI protocols: file:// - Fetches files, which are usually files shipped with - the - Metadata, + the metadata, from the local machine. The path is relative to the FILESPATH @@ -1116,7 +1118,7 @@ any special package name suffix. files - - Files within a directory, which is named + Files within a directory that is named files and is also alongside the recipe or append file. @@ -1144,11 +1146,11 @@ svk:// - Fetches files from an SVK revision control repository. http:// - Fetches files from - the Internet using http. + the Internet using HTTP. https:// - Fetches files - from the Internet using https. + from the Internet using HTTPS. ftp:// - Fetches files - from the Internet using ftp. + from the Internet using FTP. cvs:// - Fetches files from a CVS revision control repository. hg:// - Fetches files from @@ -1240,9 +1242,8 @@ The revision of the source code used to build the package. - This variable applies to Subversion, Git, Mercurial and Bazaar - only. - Note that if you wish to build a fixed revision and you wish + This variable applies only when using Subversion, Git, Mercurial and Bazaar. + If you want to build a fixed revision and you want to avoid performing a query on the remote repository every time BitBake parses your recipe, you should specify a SRCREV that is a full revision identifier and not just a tag. @@ -1263,7 +1264,7 @@ SUMMARY - A short (72 characters or less) summary for the recipe. + A short summary for the recipe, which is 72 characters or less. @@ -1274,7 +1275,7 @@ T - This variable points to a directory were BitBake places + Points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe. @@ -1284,7 +1285,7 @@ TOPDIR - This variable points to the + Points to the Build Directory. BitBake automatically sets this variable. -- cgit v1.2.3-54-g00ecf