From 7bd3a81ef54b790943577409e30c825fe9d4182c Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 24 Sep 2013 12:22:31 -0700 Subject: [PATCH] ref-manual: New migration section for 1.5 and new variables 1. Created the first draft of the new migration section for moving to the YP 1.5 release. 2. Created new variable glossary descriptions for the SDK_NAME, IMAGE_NAME, and DATETIME variables. (From yocto-docs rev: 26e6a7675183b49a0ee8059d81218dbc5cd14bd4) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/migration.xml | 463 +++++++++++++++++++++ documentation/ref-manual/ref-variables.xml | 97 ++++- 2 files changed, 559 insertions(+), 1 deletion(-) diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 302ce4cea8..af7eed3892 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -580,6 +580,469 @@ + +
+ Moving to the Yocto Project 1.5 Release + + + This section provides migration information for moving to the + Yocto Project 1.5 Release from the prior release. + + +
+ Host Dependency Changes + + + 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. + + 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 + containing them. + + + + For more information on this requirement, see the + "Required Git, tar, and Python Versions" + section. + +
+ +
+ <filename>atom-pc</filename> Board Support Package (BSP) + + + The atom-pc hardware reference BSP has been + replaced by a genericx86 BSP. + This BSP is not necessarily guaranteed to work on all x86 + hardware, but it will run on a wider range of systems than the + atom-pc did. + + Additionally, a genericx86-64 BSP has been + added for 64-bit systems. + + +
+ +
+ BitBake <filename>_remove</filename> Operator + + + 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. + +
+ +
+ QA Warnings + + + The following QA warnings exist: + + + If you have customized + ERROR_QA + or WARN_QA + values in your configuration, check that they contain all of + the issues that you wish to be reported. + Previous Yocto Project versions contained a bug that meant + that any item not mentioned in ERROR_QA + or WARN_QA would be treated as a + warning. + Consequently, several important items were not already in + the default value of WARN_QA. + All of the possible QA checks are now documented in the + "insane.bbclass" + section. + + An additional QA check has been added to check if + /usr/share/info/dir is being installed. + Your recipe should delete this file within + do_install if "make install" is + installing it. + + If you are using the buildhistory class, the check for the + package version going backwards is now controlled using a + standard QA check. + Thus, if you have customized your + ERROR_QA or + WARN_QA values and still wish to have + this check performed, you should add + "version-going-backwards" to your value for one or the + other variables depending on how you wish it to be handled. + + + +
+ +
+ Directory Layout Changes + + + The following directory changes exist: + + + Output SDK installer files are now named to include the + image name and tuning architecture through the + SDK_NAME + variable. + + Images and related files are now installed into a directory + that is specific to the machine, instead of a parent + directory containing output files for multiple machines. + The + DEPLOY_DIR_IMAGE + variable continues to point to the directory containing + images for the current + MACHINE + and should be used anywhere there is a need to refer to + this directory. + The runqemu script now uses this + variable to find images and kernel binaries and will use + BitBake to determine the directory. + Alternatively, you can set the + DEPLOY_DIR_IMAGE variable in the + external environment. + + When buildhistory is enabled, its output is now written + under the + Build Directory + rather than + TMPDIR. + Doing so makes it a easier to delete + TMPDIR and preserve the build history. + Additionally, data for produced SDKs is now split by + IMAGE_NAME. + + + The pkgdata directory produced as + part of the packaging process has been collapsed into a + single machine-specific directory. + + +
+ +
+ Shortened Git <filename>SRCREV</filename> Values + + + BitBake will now shorten revisions from Git repositories from the + normal 40 characters down to 10 characters within + SRCPV + for improved usability in path and file names. + 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. + + +
+ +
+ <filename>IMAGE_FEATURES</filename> + + + These + IMAGE_FEATURES + exist: + + + The value of + IMAGE_FEATURES + is now validated to ensure invalid feature items are not + added. + Some users mistakenly add package names to this variable + instead of using + IMAGE_INSTALL + in order to have the package added to the image, which does + not work. + This change is intended to catch those kinds of situations. + Valid IMAGE_FEATURES are drawn from + PACKAGE_GROUP + definitions, + COMPLEMENTARY_GLOBS + 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 previously deprecated "apps-console-core" + IMAGE_FEATURES item is no longer + supported. + Add "splash" to IMAGE_FEATURES if you + wish to have the splash screen enabled, since this is + all that apps-console-core was doing. + + +
+ +
+ <filename>/run</filename> + + + The /run directory from the Filesystem + Hierarchy Standard 3.0 has been introduced. + You can find some of the implications for this change + here. + The change also means that recipes that install files to + /var/run must be changed. + You can find a guide on how to make these changes + here. + +
+ +
+ Removal of Package Manager Database Within Image Recipes + + + The image core-image-minimal no longer adds + remove_packaging_data_files to + ROOTFS_POSTPROCESS_COMMAND. + 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. + +
+ +
+ Images Now Rebuild Only on Changes Instead of Every Time + + + The do_rootfs and other related image + construction tasks are no longer marked as "nostamp". + Consequently, they will only be re-executed when their inputs have + changed. + Previous versions of the OpenEmbedded build system always rebuilt + the image when requested rather when necessary. + +
+ +
+ Task Recipes + + + The previously deprecated task.bbclass has + now been dropped. + You should remove recipes that previously inherited from this task + and rename from task-* to + packagegroup-* and inherit packagegroup + instead. + + + + For more information, see the + "Package Groups - packagegroup.bbclass" + section. + +
+ +
+ BusyBox + + + By default, we now split BusyBox into two binaries: + one that is suid root for those components that need it, and + another for the rest of the components. + Splitting BusyBox allows for optimization that eliminates the + tinylogin recipe as recommended by upstream. + You can disable this split by setting + BUSYBOX_SPLIT_SUID + to "0". + +
+ +
+ Automated Image Testing + + + A new automated image testing framework has been added + through the + testimage*.bbclass + class. + This framework replaces the older + imagetest-qemu framework. + + + + You can learn more about performing automated image tests in the + "Performing Automated Runtime Testing" + section. + +
+ +
+ Removed and Renamed Recipes + + + + The linux-yocto 3.2 kernel has been + removed. + + libtool-nativesdk has been renamed to + nativesdk-libtool. + + tinylogin has been removed. + It has been replaced by a suid portion of Busybox. + See the + "BusyBox" section + for more information. + + external-python-tarball has been renamed + to buildtools-tarball. + + + web-webkit has been removed. + It has been functionally replaced by + midori. + + imake has been removed. + It is no longer needed by any other recipe. + + + transfig-native has been removed. + It is no longer needed by any other recipe. + + + anjuta-remote-run has been removed. + Support for Anjuta IDE integration has not existed for some + several releases. + +
+ +
+ 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. + + + classes/image: Ensure + BAD_RECOMMENDATIONS + supports pre-renamed package names. + + classes/rootfs_rpm: Implement + BAD_RECOMMENDATIONS + for RPM. + + systemd: Remove + systemd_unitdir if + systemd is not in distro features. + + + systemd: Remove + init.d dir if + systemd unit file is present and + sysvinit is not a distro feature. + + + 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 + conflict with multilib. + See + YOCTO #4993 + in Bugzilla for more information. + + + 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. + + + +
+
H - I + I K L @@ -819,6 +819,14 @@ Core layer for images cannot be removed + BUSYBOX_SPLIT_SUID + + + Need description. + + + + C @@ -885,6 +893,14 @@ Core layer for images cannot be removed + COMPLEMENTARY_GLOBS + + + Need description. + + + + CONFFILES @@ -994,6 +1010,17 @@ Core layer for images cannot be removed + DATETIME + + + The date and time on which the build started: + + date/time + + + + + DEBUG_BUILD @@ -1853,6 +1880,14 @@ Core layer for images cannot be removed I + IMAGE_BASENAME + + + Need description. + + + + IMAGE_CLASSES @@ -1992,6 +2027,23 @@ Core layer for images cannot be removed + IMAGE_NAME + + + The name of the output image files minus the extension. + This variable is derived using the + IMAGE_BASENAME + MACHINE + and + DATETIME + variables: + + IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" + + + + + IMAGE_OVERHEAD_FACTOR @@ -3620,6 +3672,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + PACKAGE_GROUP + + + Need description. + + + + PACKAGE_INSTALL @@ -4567,6 +4627,33 @@ PARALLEL_MAKEINST with the description ". + SDK_ARCH + + + Need description. + + + + + SDK_NAME + + + The base name for SDK output files. + The name is derived from the + DISTRO, + TCLIBC, + SDK_ARCH, + IMAGE_BASENAME, + and + TUNE_PKGARCH + variables: + + SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" + + + + + SDKIMAGE_FEATURES Equivalent to @@ -5480,6 +5567,14 @@ PARALLEL_MAKEINST with the description ". + TUNE_PKGARCH + + + Need description. + + + + U