From a8a240405326b6e1c6546c8b3a7ebc5eabeb4896 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 30 Sep 2013 08:49:31 -0700 Subject: [PATCH] ref-manual: Updated 1.5 Migration section and COMPLEMENTARY_GLOB variable Review edits from Paul Egglegon applied to the Migrating to 1.5 section. Also, part of the review affected the COMPLEMENTARY_GLOB variable entry in the glossary. (From yocto-docs rev: 941a388f45c99403f5cb480bf3e5aae55a800994) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/migration.xml | 201 ++++++++++++--------- documentation/ref-manual/ref-variables.xml | 50 ++--- 2 files changed, 142 insertions(+), 109 deletions(-) diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 9915c3ce02..4c7af582fa 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -599,7 +599,7 @@ Python 2.7.3+ Tar 1.24+ Git 1.7.5+ - Patched version of Make if you are using + Patched version of Make if you are using 3.82. Most distributions that provide Make 3.82 use the patched version. @@ -633,15 +633,46 @@ -
- BitBake <filename>_remove</filename> Operator +
+ BitBake - BitBake now supports a _remove operator. - The addition of this operator means you will have to rename any - items in recipe space (functions, variables) whose names currently - contain _remove_ or end with - _remove to avoid unexpected behavior. + The following changes have been made that relate to BitBake: + + + BitBake now supports a _remove + operator. + The addition of this operator means you will have to + rename any items in recipe space (functions, variables) + whose names currently contain + _remove_ or end with + _remove to avoid unexpected behavior. + + + BitBake's global method pool has been removed. + This method not particularly useful and led to clashes + between recipes containing functions that had the + same name. + + The "none" server backend has been removed. + The "process" server backend has been serving well as the + default for a long time now. + + The bitbake-runtask script has been + removed. + + ${P} + and + ${PF} + are no longer added to + PROVIDES + by default. + These version-specific PROVIDES + items were seldom used. + Attempting to use them could result in two versions being + built simultaneously rather than just one version due to + the way BitBake resolves dependencies. +
@@ -684,7 +715,7 @@ other variables depending on how you wish it to be handled. See the documented QA checks in the "insane.bbclass" - section. + section. @@ -733,9 +764,9 @@ The pkgdata directory produced as part of the packaging process has been collapsed into a single machine-specific directory. - These directories are located under - sysroots and use a machine-specific - name (i.e. + This directory is located under + sysroots and uses a machine-specific + name (i.e. tmp/sysroots/<machine>/pkgdata). @@ -753,10 +784,8 @@ This change should be safe within contexts where these revisions are used because the chances of spatially close collisions is very low. - - Distant collisions are not a major issue in the way - the values are used. - + Distant collisions are not a major issue in the way + the values are used.
@@ -764,9 +793,8 @@ <filename>IMAGE_FEATURES</filename> - These - IMAGE_FEATURES - exist: + The following changes have been made that relate to + IMAGE_FEATURES: The value of @@ -783,10 +811,11 @@ PACKAGE_GROUP definitions, COMPLEMENTARY_GLOB - and a new 'validitems' varflag on + and a new "validitems" varflag on IMAGE_FEATURES. - This change allows additional features to be added if they - are not provided using the previous two mechanisms. + The "validitems" varflag change allows additional features + to be added if they are not provided using the previous + two mechanisms. The previously deprecated "apps-console-core" @@ -824,9 +853,9 @@ This addition is now handled automatically when "package-management" is not in IMAGE_FEATURES. - If you have custom image recipes that makes this addition, - you should remove the lines, as it is not needed and may interfere - with correct operation of postinstall scripts. + If you have custom image recipes that make this addition, + you should remove the lines, as they are not needed and might + interfere with correct operation of postinstall scripts. @@ -849,8 +878,8 @@ The previously deprecated task.bbclass has now been dropped. - You should remove recipes that previously inherited from this task - and rename from task-* to + For recipes that previously inherited from this task, you should + rename them from task-* to packagegroup-* and inherit packagegroup instead. @@ -930,51 +959,82 @@ anjuta-remote-run has been removed. - Support for Anjuta IDE integration has not existed for some + Anjuta IDE integration has not been officially supported for several releases. +
+ Build History + + + Following are changes to Build History: + + + Installed package sizes: + installed-package-sizes.txt for an + image now records the size of the files installed by each + package instead of the size of each compressed package + archive file. + + The dependency graphs (depends*.dot) + now use the actual package names instead of replacing + dashes, dots and plus signs with underscores. + + + The buildhistory-diff and + buildhistory-collect-srcrevs + utilities have improved command-line handling. + Use the ‐‐help option for + each utility for more information on the new syntax. + + + For more information on Build History, see the + "Maintaining Build Output Quality" + section. + +
+ +
+ <filename>udev</filename> + + + Following are changes to udev: + + + udev no longer brings in + udev-extraconf automatically + through + RRECOMMENDS, + since this was originally intended to be optional. + If you need the extra rules, then add + udev-extraconf to your image. + + + udev no longer brings in + pciutils-ids or + usbutils-ids through + RRECOMMENDS. + These are not needed by udev itself + and removing them saves around 350KB. + + + +
+
Other Changes Following is a list of short entries describing other changes: - - BitBake: methodpool: Retire this. - Remove global method scope. - - BitBake: server: Remove none server. - - BitBake: Drop bitbake-runtask. - - - Do not recommend udev-extraconf - for udev. - - udev: Do not recommend - pciutils/usbutils ids - run-postinsts: Make this generic. - - classes/externalsrc: Enable global - inherit and simplify usage. - - BusyBox: Enable to list suid and non-suid app configs. - base-files: Remove the unnecessary /media/xxx directories. - - classes/testimage.bbclass: New class - for image tests. - See the - "testimage.bbclass" - section for more information. alsa-state: Provide an empty asound.conf by default. @@ -990,7 +1050,8 @@ systemd: Remove systemd_unitdir if - systemd is not in distro features. + systemd is not in + DISTRO_FEATURES. systemd: Remove @@ -1002,10 +1063,6 @@ libpam: Deny all services for the OTHER entries. - - Add libav and use it in - gst-ffmpeg by default. - image.bbclass: Move runtime_mapping_rename to avoid @@ -1018,34 +1075,10 @@ linux-dtb: Use kernel build system to generate the dtb files. - - classes/buildhistory: Record the - size of the installed package not the compressed archive. - - - classes/buildhistory: Avoid mangling - names in dot graphs for images. - - - buildhistory-diff/buildhistory-collect-srcrevs: - Improved command-line handling. - kern-tools: Switch from guilt to new kgit-s2q tool. - - poky.conf: Do not force the addition - of extra - DISTRO_FEATURES. - - - bitbake.conf: Stop providing - ${P} - and - ${PF} - by default. -
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index cf964c78a7..8133b9d14b 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -822,15 +822,15 @@ Core layer for images cannot be removed BUSYBOX_SPLIT_SUID - 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 + 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). + setuid root). - The BUSYBOX_SPLIT_SUID variable + 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. @@ -907,21 +907,21 @@ Core layer for images cannot be removed COMPLEMENTARY_GLOB - Defines wildcards you can use when installing a list of - complementary packages for all the packages explicitly + Defines wildcards to match 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 + 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 + An example usage of this is the "dev-pkgs" item that when added to IMAGE_FEATURES will - install -dev packages (containing headers and other + 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 + 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: @@ -1911,8 +1911,8 @@ Core layer for images cannot be removed IMAGE_BASENAME - The base name of image output files. - This variable defaults to the recipe name + The base name of image output files. + This variable defaults to the recipe name (${PN}). @@ -3705,8 +3705,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PACKAGE_GROUP - Defines one or more packages to include in an image when - a specific item is included in + 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. @@ -3714,15 +3714,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PACKAGE_GROUP_widget = "package1 package2" - In this example, if "widget" were added to + 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 + Packages installed by features defined through + PACKAGE_GROUP are often package groups. - While similarly named, you should not confuse the - PACKAGE_GROUP variable with + While similarly named, you should not confuse the + PACKAGE_GROUP variable with package groups, which are discussed elsewhere in the documentation. @@ -4680,7 +4680,7 @@ PARALLEL_MAKEINST with the description ". SDK_ARCH - The target architecture for the SDK. + The target architecture for the SDK. Typically, you do not directly set this variable. Instead, use SDKMACHINE. @@ -5623,8 +5623,8 @@ PARALLEL_MAKEINST with the description ". TUNE_PKGARCH - The package architecture understood by the packaging - system to define the architecture, ABI, and tuning of + The package architecture understood by the packaging + system to define the architecture, ABI, and tuning of output packages.