From 7b0e4fb0674189c21a0046bb1208ec85c7ea7190 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 9 Dec 2013 14:43:18 -0600 Subject: ref-manual: Review edits from "I" through "Z" classes. icecc - added link to Icecream. images - added some reference links to the end of the section. logging - added closing ")" character. nativesdk - corrected the mis-copied recipe name. own-mirrors - fixed the class name so it was not "ownmirrors". package - minor tweak to indicate class. Also spelled Berkeley correctly. package_deb, package_ipk, and package_rpm - dumped a note and mentioned that you need PACKAGE_CLASSES to enable the class. package_tar - noted that the recipe inheriting the tar class is what does the trick here. pixbufcache - minor edits populate_sdk - minor edits prserv - edits to tell how it is enabled. pythonnative - re-worded it. rootfs* - reworded. rootfs_deb, rootfs_ipk, and rootfs_rpm - Brand new. systemd - reworded. terminal - rewording useradd - reworded (From yocto-docs rev: 110c192499a0e349b317e51aeca1a391c35785fc) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.xml | 192 ++++++++++++++++++++----------- 1 file changed, 127 insertions(+), 65 deletions(-) (limited to 'documentation/ref-manual/ref-classes.xml') diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index d38071e122..555918e80a 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -902,9 +902,10 @@ <filename>icecc.bbclass</filename> - The icecc class supports Icecream, which + The icecc class supports + Icecream, which facilitates taking compile jobs and distributing them among remote - machines to achieve parallelism during the build. + machines. @@ -996,9 +997,10 @@ variable controls the list of packages to install into the image. - For more information on customizing images, see the + For information on customizing images, see the "Customizing Images" - section in the Yocto Project Development Manual and the + section in the Yocto Project Development Manual. + For information on how images are created, see the "Images" section elsewhere in this manual. @@ -1603,7 +1605,7 @@ shell functions used to log messages for various BitBake severity levels (i.e. bbplain, bbnote, bbwarn, bberror, - bbfatal, and bbdebug. + bbfatal, and bbdebug). @@ -1739,7 +1741,7 @@ You can create a recipe that builds tools that run on the SDK machine a couple different ways: - Create a myrecipe-native.bb + Create a myrecipe-nativesdk.bb recipe that inherits the nativesdk class. Create a nativesdk variant @@ -1783,11 +1785,11 @@ -
- <filename>ownmirrors.bbclass</filename> +
+ <filename>own-mirrors.bbclass</filename> - The ownmirrors class makes it + The own-mirrors class makes it easier to set up your own PREMIRRORS from which to first fetch source before attempting to fetch it from the @@ -1813,7 +1815,7 @@ <filename>package.bbclass</filename> - The package supports generating + The package class supports generating packages from a build's output. The core generic functionality is in package.bbclass. @@ -1877,7 +1879,7 @@ ACID style upgrade, and repackaging abilities for rollbacks. - For smaller systems, the extra space used for the Berkley + For smaller systems, the extra space used for the Berkeley Database and the amount of metadata when using RPM can affect your ability to perform on-device upgrades. @@ -1906,11 +1908,14 @@ The class ensures the packages are written out to the ${DEPLOY_DIR}/deb directory in a .deb file format. - - This package inherits the - package - class. - + + + + This class inherits the + package + class and is enabled through the + PACKAGE_CLASSES + variable in the local.conf file.
@@ -1924,11 +1929,14 @@ The class ensures the packages are written out to the ${DEPLOY_DIR}/ipk directory in a .ipk file format. - - This package inherits the - package - class. - + + + + This class inherits the + package + class and is enabled through the + PACKAGE_CLASSES + variable in the local.conf file.
@@ -1942,11 +1950,14 @@ The class ensures the packages are written out to the ${DEPLOY_DIR}/rpm directory in a .rpm file format. - - This package inherits the - package - class. - + + + + This class inherits the + package + class and is enabled through the + PACKAGE_CLASSES + variable in the local.conf file. @@ -1960,11 +1971,12 @@ The class ensures the packages are written out to the ${DEPLOY_DIR}/tar directory in a .tar file format. - - This package inherits the - package - class. - + + + + This class inherits the + package + class and is for a given recipe when the recipe inherits the class. @@ -2061,7 +2073,7 @@ that install pixbuf loaders, which are used with gdk-pixbuf. These scriptlets call update_pixbuf_cache - to add the input method modules to the cache. + to add the pixbuf loaders to the cache. Since the cache files are architecture-specific, update_pixbuf_cache is run using QEMU if the postinst scriptlets need to be run on the build host during image @@ -2072,7 +2084,7 @@ If the pixbuf loaders modules being installed are in packages other than the main package, set PIXBUF_PACKAGES - to include the packages containing the modules. + to specify the packages containing the modules. @@ -2098,8 +2110,8 @@ <filename>populate_sdk.bbclass</filename> - The populate_sdk class facilitates compatibility - with SDK-only recipes. + The populate_sdk class provides support for + SDK-only recipes. @@ -2212,8 +2224,8 @@ This class is enabled by default because it is inherited by the package class. - However, the OpenEmbedded build system will not use this variable - unless + However, the OpenEmbedded build system will not enable the + functionality of this class unless PRSERV_HOST has been set. @@ -2253,11 +2265,9 @@ <filename>pythonnative.bbclass</filename> - The pythonnative causes the OpenEmbedded build - system to use the native version of Python, which is built by the - build system. - Normally, the OpenEmbedded build system uses the version of Python - that is built by the build host. + When inherited by a recipe, the pythonnative class + supports using the native version of Python built by the build system + rather than using the version provided by the build host. This class must be inherited by a recipe in order to be used. @@ -2399,21 +2409,72 @@ The rootfs* classes add support for creating - images in several formats and consist of the following: + the root filesystem in either .ext3 or + tar.bz2 formats and consist of the following + classes: The - IMAGE_FSTYPES - variable controls the types of images to generate. - + rootfs_deb + class. The - IMAGE_INSTALL - variable controls the list of packages to install into the - image. + rootfs_rpm + class. + The + rootfs_ipk + class. - First, the root filesystem is created from packages using - one of the rootfs_*.bbclass - files (depending on the package format used) and then the image - is created. + + + + The root filesystem is created from packages using one of the + rootfs_*.bbclass files as determined by the + IMAGE_FSTYPES + variable. + + + + For information on how root filesystem images are created, see the + "Image Generation" + section. + + + +
+ <filename>rootfs_deb.bbclass</filename> + + + The rootfs_deb class supports creation of + root filesystems for images built using .deb + packages. + See the + "rootfs*.bbclass" + section for more information. + +
+ +
+ <filename>rootfs_ipk.bbclass</filename> + + + The rootfs_ipk class supports creation of + root filesystems for images built using .ipk + packages. + See the + "rootfs*.bbclass" + section for more information. + +
+ +
+ <filename>rootfs_rpm.bbclass</filename> + + + The rootfs_rpm class supports creation of + root filesystems for images built using .rpm + packages. + See the + "rootfs*.bbclass" + section for more information.
@@ -2458,7 +2519,7 @@ The setuptools class supports extensions that use - setuptools-based build systems. + setuptools-based build systems making use of Python. If your recipe uses these build systems, the recipe needs to inherit the setuptools class. @@ -2631,9 +2692,10 @@ - Under this class, unit files are installed into - ${D}${systemd_unitdir}/system - during the do_install task. + Under this class, the recipe or Makefile (i.e. whatever the recipe is + calling during the do_install task) installs unit + files into + ${D}${systemd_unitdir}/system. If the unit files being installed go into packages other than the main package, you need to set SYSTEMD_PACKAGES @@ -2678,9 +2740,9 @@ - You can use this class anywhere a separate terminal session needs to - be started. - To use the class, include the + Other classes use the terminal class anywhere a + separate terminal session needs to be started. + The class is used by including the patch class if PATCHRESOLVE @@ -2867,11 +2929,11 @@ <filename>useradd.bbclass</filename> - The useradd class supports recipes that restrict - packages to certain users or groups. - For example, if you have packages that install files that are owned - by custom users or groups, you can use this class to specify - those packages and then associate them with the users and groups. + The useradd class supports the addition of users + or groups for usage by the package on the target. + For example, if you have packages that contain system services that + should be run under their own user or group, you can use this class to + enable creation of the user or group. The meta-skeleton/recipes-skeleton/useradd/useradd-example.bb recipe in the Source Directory provides a simple example that shows how to add three -- cgit v1.2.3-54-g00ecf