From 08b634e6161433226ebdefe8c1160ea7df30b8d7 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 5 Dec 2013 14:23:01 -0600 Subject: ref-manual: Re-ordered classes that start with "P". (From yocto-docs rev: 9973801d392d3815d291beca8c8ca27f5c67bae8) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.xml | 380 +++++++++++++++---------------- 1 file changed, 190 insertions(+), 190 deletions(-) (limited to 'documentation') diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 0c0316efdf..0ad7d0f5d6 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -1717,21 +1717,162 @@ -
- Pkg-config - <filename>pkgconfig.bbclass</filename> +
+ <filename>package.bbclass</filename> - pkg-config provides a standard way to get - header and library information. - This class aims to smooth integration of - pkg-config into libraries that use it. + The packaging class (package) supports generating + packages from a build's output. + The core generic functionality is in the + package.bbclass. + The code specific to particular package types resides in these + package-specific classes: + package_deb, + package_rpm, + package_ipk, + and + package_tar. - During staging, BitBake installs pkg-config data into the - sysroots/ directory. - By making use of sysroot functionality within pkg-config, - this class no longer has to manipulate the files. + You can control the list of resulting package formats by using the + PACKAGE_CLASSES + variable defined in your conf/local.conf + configuration file, which is located in the + Build Directory. + When defining the variable, you can specify one or more package types. + Since images are generated from packages, a packaging class is + needed to enable image generation. + The first class listed in this variable is used for image generation. + + + + If you take the optional step to set up a repository (package feed) + on the development host that can be used by Smart, you can + install packages from the feed while you are running the image + on the target (i.e. runtime installation of packages). + For more information, see the + "Using Runtime Package Management" + section in the Yocto Project Development Manual. + + + + The package-specific class you choose can affect build-time performance + and has space ramifications. + In general, building a package with IPK takes about thirty percent less + time as compared to using RPM to build the same or similar package. + This comparison takes into account a complete build of the package with + all dependencies previously built. + The reason for this discrepancy is because the RPM package manager + creates and processes more + Metadata than the + IPK package manager. + Consequently, you might consider setting + PACKAGE_CLASSES to "package_ipk" if you are + building smaller systems. + + + + Before making your package manager decision, however, you should + consider some further things about using RPM: + + + RPM starts to provide more abilities than IPK due to + the fact that it processes more Metadata. + For example, this information includes individual file types, + file checksum generation and evaluation on install, sparse file + support, conflict detection and resolution for Multilib systems, + ACID style upgrade, and repackaging abilities for rollbacks. + + + For smaller systems, the extra space used for the Berkley + Database and the amount of metadata when using RPM can affect + your ability to perform on-device upgrades. + + + + + + You can find additional information on the effects of the package + class at these two Yocto Project mailing list links: + + + https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html + + https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html + + +
+ +
+ <filename>package_deb.bbclass</filename> + + + The Debian package manager (package_deb) class + provides support for creating packages that use the + .deb file format. + 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. + + +
+ +
+ <filename>package_ipk.bbclass</filename> + + + The Itsy package manager (package_ipk) class + provides support for creating packages that use the + .ipk file format. + 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. + + +
+ +
+ <filename>package_rpm.bbclass</filename> + + + The RPM package manager (package_deb) class + provides support for creating packages that use the + .rpm file format. + 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. + + +
+ +
+ <filename>package_tar.bbclass</filename> + + + The consolidated Unix archive file (package_tar) + class provides support for creating packages that use the + .tar file format. + 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. +
@@ -1754,6 +1895,27 @@
+
+ Package Groups - <filename>packagegroup.bbclass</filename> + + + This class sets default values appropriate for package group recipes (e.g. + PACKAGES, + PACKAGE_ARCH, + ALLOW_EMPTY, + and so forth). + It is highly recommended that all package group recipes inherit this class. + + + For information on how to use this class, see the + "Customizing Images Using Custom Package Groups" + section in the Yocto Project Development Manual. + + + Previously, this class was named task.bbclass. + +
+
<filename>packageinfo.bbclass</filename> @@ -1819,6 +1981,24 @@
+
+ Pkg-config - <filename>pkgconfig.bbclass</filename> + + + pkg-config provides a standard way to get + header and library information. + This class aims to smooth integration of + pkg-config into libraries that use it. + + + + During staging, BitBake installs pkg-config data into the + sysroots/ directory. + By making use of sysroot functionality within pkg-config, + this class no longer has to manipulate the files. + +
+
<filename>populate_sdk.bbclass</filename> @@ -2117,168 +2297,6 @@
-
- Package Groups - <filename>packagegroup.bbclass</filename> - - - This class sets default values appropriate for package group recipes (e.g. - PACKAGES, - PACKAGE_ARCH, - ALLOW_EMPTY, - and so forth). - It is highly recommended that all package group recipes inherit this class. - - - For information on how to use this class, see the - "Customizing Images Using Custom Package Groups" - section in the Yocto Project Development Manual. - - - Previously, this class was named task.bbclass. - -
- -
- <filename>package.bbclass</filename> - - - The packaging class (package) supports generating - packages from a build's output. - The core generic functionality is in the - package.bbclass. - The code specific to particular package types resides in these - package-specific classes: - package_deb, - package_rpm, - package_ipk, - and - package_tar. - - - - You can control the list of resulting package formats by using the - PACKAGE_CLASSES - variable defined in your conf/local.conf - configuration file, which is located in the - Build Directory. - When defining the variable, you can specify one or more package types. - Since images are generated from packages, a packaging class is - needed to enable image generation. - The first class listed in this variable is used for image generation. - - - - If you take the optional step to set up a repository (package feed) - on the development host that can be used by Smart, you can - install packages from the feed while you are running the image - on the target (i.e. runtime installation of packages). - For more information, see the - "Using Runtime Package Management" - section in the Yocto Project Development Manual. - - - - The package-specific class you choose can affect build-time performance - and has space ramifications. - In general, building a package with IPK takes about thirty percent less - time as compared to using RPM to build the same or similar package. - This comparison takes into account a complete build of the package with - all dependencies previously built. - The reason for this discrepancy is because the RPM package manager - creates and processes more - Metadata than the - IPK package manager. - Consequently, you might consider setting - PACKAGE_CLASSES to "package_ipk" if you are - building smaller systems. - - - - Before making your package manager decision, however, you should - consider some further things about using RPM: - - - RPM starts to provide more abilities than IPK due to - the fact that it processes more Metadata. - For example, this information includes individual file types, - file checksum generation and evaluation on install, sparse file - support, conflict detection and resolution for Multilib systems, - ACID style upgrade, and repackaging abilities for rollbacks. - - - For smaller systems, the extra space used for the Berkley - Database and the amount of metadata when using RPM can affect - your ability to perform on-device upgrades. - - - - - - You can find additional information on the effects of the package - class at these two Yocto Project mailing list links: - - - https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html - - https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html - - -
- -
- <filename>package_deb.bbclass</filename> - - - The Debian package manager (package_deb) class - provides support for creating packages that use the - .deb file format. - 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. - - -
- -
- <filename>package_rpm.bbclass</filename> - - - The RPM package manager (package_deb) class - provides support for creating packages that use the - .rpm file format. - 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. - - -
- -
- <filename>package_ipk.bbclass</filename> - - - The Itsy package manager (package_ipk) class - provides support for creating packages that use the - .ipk file format. - 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. - - -
-
<filename>sip.bbclass</filename> @@ -2443,24 +2461,6 @@
-
- <filename>package_tar.bbclass</filename> - - - The consolidated Unix archive file (package_tar) - class provides support for creating packages that use the - .tar file format. - 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. - - -
-
<filename>rootfs*.bbclass</filename> -- cgit v1.2.3-54-g00ecf