From 0d194a8c621006d3846f9fe3a756ce71a15f733a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 27 Sep 2013 13:58:02 -0700 Subject: dev-manual, ref-manual: Review edits for new variables. Applied review changes to the following variables: IMAGE_NAME DATETIME SDK_ARCH IMAGE_BASENAME TUNE_PKGARCH PACKAGE_GROUP COMPLEMENTARY_GLOB BUSYBOX_SPLIT_SUID Also, reformatted some 1.5 package version requirements into a list rather than a lazy literallayout tag. Provided some new wording for the "Directory Layout Changes" section in the Migration chapter. (From yocto-docs rev: 60c3a905dd9212f1b4f6969341640a0726342d11) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/migration.xml | 28 ++++++----- documentation/ref-manual/ref-variables.xml | 81 +++++++++++++++++++++++++----- 2 files changed, 84 insertions(+), 25 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 1b3b9d99dc..9915c3ce02 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -595,16 +595,15 @@ The OpenEmbedded build system now has some additional requirements on the host system: - - Python 2.7.3+ - - tar 1.24+ - - git 1.7.5+ - - Patched version of make if you are using make version 3.82. Most - distributions that provide make 3.82 have now done this. - + + Python 2.7.3+ + Tar 1.24+ + Git 1.7.5+ + Patched version of Make if you are using + 3.82. + Most distributions that provide Make 3.82 use the patched + version. + If the Linux distribution you are using on your build host does not provide packages for these, you can install and use the Buildtools tarball, which provides an SDK-like environment @@ -733,7 +732,12 @@ The pkgdata directory produced as part of the packaging process has been collapsed into a - single machine-specific directory. + single machine-specific directory. + These directories are located under + sysroots and use a machine-specific + name (i.e. + tmp/sysroots/<machine>/pkgdata). + @@ -778,7 +782,7 @@ Valid IMAGE_FEATURES are drawn from PACKAGE_GROUP definitions, - COMPLEMENTARY_GLOBS + COMPLEMENTARY_GLOB and a new 'validitems' varflag on IMAGE_FEATURES. This change allows additional features to be added if they diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index c1e2013f42..cf964c78a7 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -822,7 +822,18 @@ Core layer for images cannot be removed BUSYBOX_SPLIT_SUID - Need description. + For the BusyBox recipe, specifies whether to split the + output executable file into two parts: one for features + that require setuid root, and one for + the remaining features (i.e. those that do not require + setuid root). + + + + The BUSYBOX_SPLIT_SUID variable + defaults to "1", which results in a single output + executable file. + Set the variable to "0" to split the output file. @@ -893,10 +904,29 @@ Core layer for images cannot be removed - COMPLEMENTARY_GLOBS + COMPLEMENTARY_GLOB - Need description. + Defines wildcards you can use when installing a list of + complementary packages for all the packages explicitly + (or implicitly) installed in an image. + The resulting list of complementary packages is associated + with an item that can be added to + IMAGE_FEATURES. + An example usage of this is the "dev-pkgs" item that when + added to IMAGE_FEATURES will + install -dev packages (containing headers and other + development files) for every package in the image. + + + + To add a new feature item pointing to a wildcard, use a + variable flag to specify the feature item name and + use the value to specify the wildcard. + Here is an example: + + COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' + @@ -1013,10 +1043,8 @@ Core layer for images cannot be removed DATETIME - The date and time on which the build started: - - date/time - + The date and time on which the current build started. + The format is suitable for timestamps. @@ -1883,7 +1911,9 @@ Core layer for images cannot be removed IMAGE_BASENAME - Need description. + The base name of image output files. + This variable defaults to the recipe name + (${PN}). @@ -2032,8 +2062,8 @@ Core layer for images cannot be removed The name of the output image files minus the extension. This variable is derived using the - IMAGE_BASENAME - MACHINE + IMAGE_BASENAME, + MACHINE, and DATETIME variables: @@ -3675,7 +3705,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PACKAGE_GROUP - Need description. + Defines one or more packages to include in an image when + a specific item is included in + IMAGE_FEATURES. + When setting the value, PACKAGE_GROUP + should have the name of the feature item as an override. + Here is an example: + + PACKAGE_GROUP_widget = "package1 package2" + + In this example, if "widget" were added to + IMAGE_FEATURES, "package1" and + "package2" would be included in the image. + + Packages installed by features defined through + PACKAGE_GROUP are often package + groups. + While similarly named, you should not confuse the + PACKAGE_GROUP variable with + package groups, which are discussed elsewhere in the + documentation. + @@ -4630,7 +4680,10 @@ PARALLEL_MAKEINST with the description ". SDK_ARCH - Need description. + The target architecture for the SDK. + Typically, you do not directly set this variable. + Instead, use + SDKMACHINE. @@ -5570,7 +5623,9 @@ PARALLEL_MAKEINST with the description ". TUNE_PKGARCH - Need description. + The package architecture understood by the packaging + system to define the architecture, ABI, and tuning of + output packages. -- cgit v1.2.3-54-g00ecf