diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-05 14:23:01 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-11 14:19:19 +0000 |
commit | 08b634e6161433226ebdefe8c1160ea7df30b8d7 (patch) | |
tree | 38678a929091fb6ed7d8bfb6fbfd11665749097b /documentation | |
parent | 4688e765dee9cdbc1660e783c69d7c95950f7e6d (diff) | |
download | poky-08b634e6161433226ebdefe8c1160ea7df30b8d7.tar.gz |
ref-manual: Re-ordered classes that start with "P".
(From yocto-docs rev: 9973801d392d3815d291beca8c8ca27f5c67bae8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 380 |
1 files changed, 190 insertions, 190 deletions
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 @@ | |||
1717 | </para> | 1717 | </para> |
1718 | </section> | 1718 | </section> |
1719 | 1719 | ||
1720 | <section id='ref-classes-pkgconfig'> | 1720 | <section id='ref-classes-package'> |
1721 | <title>Pkg-config - <filename>pkgconfig.bbclass</filename></title> | 1721 | <title><filename>package.bbclass</filename></title> |
1722 | 1722 | ||
1723 | <para> | 1723 | <para> |
1724 | <filename>pkg-config</filename> provides a standard way to get | 1724 | The packaging class (<filename>package</filename>) supports generating |
1725 | header and library information. | 1725 | packages from a build's output. |
1726 | This class aims to smooth integration of | 1726 | The core generic functionality is in the |
1727 | <filename>pkg-config</filename> into libraries that use it. | 1727 | <filename>package.bbclass</filename>. |
1728 | The code specific to particular package types resides in these | ||
1729 | package-specific classes: | ||
1730 | <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, | ||
1731 | <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>, | ||
1732 | <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, | ||
1733 | and | ||
1734 | <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>. | ||
1728 | </para> | 1735 | </para> |
1729 | 1736 | ||
1730 | <para> | 1737 | <para> |
1731 | During staging, BitBake installs <filename>pkg-config</filename> data into the | 1738 | You can control the list of resulting package formats by using the |
1732 | <filename>sysroots/</filename> directory. | 1739 | <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> |
1733 | By making use of sysroot functionality within <filename>pkg-config</filename>, | 1740 | variable defined in your <filename>conf/local.conf</filename> |
1734 | this class no longer has to manipulate the files. | 1741 | configuration file, which is located in the |
1742 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
1743 | When defining the variable, you can specify one or more package types. | ||
1744 | Since images are generated from packages, a packaging class is | ||
1745 | needed to enable image generation. | ||
1746 | The first class listed in this variable is used for image generation. | ||
1747 | </para> | ||
1748 | |||
1749 | <para> | ||
1750 | If you take the optional step to set up a repository (package feed) | ||
1751 | on the development host that can be used by Smart, you can | ||
1752 | install packages from the feed while you are running the image | ||
1753 | on the target (i.e. runtime installation of packages). | ||
1754 | For more information, see the | ||
1755 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>" | ||
1756 | section in the Yocto Project Development Manual. | ||
1757 | </para> | ||
1758 | |||
1759 | <para> | ||
1760 | The package-specific class you choose can affect build-time performance | ||
1761 | and has space ramifications. | ||
1762 | In general, building a package with IPK takes about thirty percent less | ||
1763 | time as compared to using RPM to build the same or similar package. | ||
1764 | This comparison takes into account a complete build of the package with | ||
1765 | all dependencies previously built. | ||
1766 | The reason for this discrepancy is because the RPM package manager | ||
1767 | creates and processes more | ||
1768 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> than the | ||
1769 | IPK package manager. | ||
1770 | Consequently, you might consider setting | ||
1771 | <filename>PACKAGE_CLASSES</filename> to "package_ipk" if you are | ||
1772 | building smaller systems. | ||
1773 | </para> | ||
1774 | |||
1775 | <para> | ||
1776 | Before making your package manager decision, however, you should | ||
1777 | consider some further things about using RPM: | ||
1778 | <itemizedlist> | ||
1779 | <listitem><para> | ||
1780 | RPM starts to provide more abilities than IPK due to | ||
1781 | the fact that it processes more Metadata. | ||
1782 | For example, this information includes individual file types, | ||
1783 | file checksum generation and evaluation on install, sparse file | ||
1784 | support, conflict detection and resolution for Multilib systems, | ||
1785 | ACID style upgrade, and repackaging abilities for rollbacks. | ||
1786 | </para></listitem> | ||
1787 | <listitem><para> | ||
1788 | For smaller systems, the extra space used for the Berkley | ||
1789 | Database and the amount of metadata when using RPM can affect | ||
1790 | your ability to perform on-device upgrades. | ||
1791 | </para></listitem> | ||
1792 | </itemizedlist> | ||
1793 | </para> | ||
1794 | |||
1795 | <para> | ||
1796 | You can find additional information on the effects of the package | ||
1797 | class at these two Yocto Project mailing list links: | ||
1798 | <itemizedlist> | ||
1799 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006362.html'> | ||
1800 | https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html</ulink></para></listitem> | ||
1801 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006363.html'> | ||
1802 | https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html</ulink></para></listitem> | ||
1803 | </itemizedlist> | ||
1804 | </para> | ||
1805 | </section> | ||
1806 | |||
1807 | <section id='ref-classes-package_deb'> | ||
1808 | <title><filename>package_deb.bbclass</filename></title> | ||
1809 | |||
1810 | <para> | ||
1811 | The Debian package manager (<filename>package_deb</filename>) class | ||
1812 | provides support for creating packages that use the | ||
1813 | <filename>.deb</filename> file format. | ||
1814 | The class ensures the packages are written out to the | ||
1815 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/deb</filename> | ||
1816 | directory in a <filename>.deb</filename> file format. | ||
1817 | <note> | ||
1818 | This package inherits the | ||
1819 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
1820 | class. | ||
1821 | </note> | ||
1822 | </para> | ||
1823 | </section> | ||
1824 | |||
1825 | <section id='ref-classes-package_ipk'> | ||
1826 | <title><filename>package_ipk.bbclass</filename></title> | ||
1827 | |||
1828 | <para> | ||
1829 | The Itsy package manager (<filename>package_ipk</filename>) class | ||
1830 | provides support for creating packages that use the | ||
1831 | <filename>.ipk</filename> file format. | ||
1832 | The class ensures the packages are written out to the | ||
1833 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/ipk</filename> | ||
1834 | directory in a <filename>.ipk</filename> file format. | ||
1835 | <note> | ||
1836 | This package inherits the | ||
1837 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
1838 | class. | ||
1839 | </note> | ||
1840 | </para> | ||
1841 | </section> | ||
1842 | |||
1843 | <section id='ref-classes-package_rpm'> | ||
1844 | <title><filename>package_rpm.bbclass</filename></title> | ||
1845 | |||
1846 | <para> | ||
1847 | The RPM package manager (<filename>package_deb</filename>) class | ||
1848 | provides support for creating packages that use the | ||
1849 | <filename>.rpm</filename> file format. | ||
1850 | The class ensures the packages are written out to the | ||
1851 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/rpm</filename> | ||
1852 | directory in a <filename>.rpm</filename> file format. | ||
1853 | <note> | ||
1854 | This package inherits the | ||
1855 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
1856 | class. | ||
1857 | </note> | ||
1858 | </para> | ||
1859 | </section> | ||
1860 | |||
1861 | <section id='ref-classes-package_tar'> | ||
1862 | <title><filename>package_tar.bbclass</filename></title> | ||
1863 | |||
1864 | <para> | ||
1865 | The consolidated Unix archive file (<filename>package_tar</filename>) | ||
1866 | class provides support for creating packages that use the | ||
1867 | <filename>.tar</filename> file format. | ||
1868 | The class ensures the packages are written out to the | ||
1869 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/tar</filename> | ||
1870 | directory in a <filename>.tar</filename> file format. | ||
1871 | <note> | ||
1872 | This package inherits the | ||
1873 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
1874 | class. | ||
1875 | </note> | ||
1735 | </para> | 1876 | </para> |
1736 | </section> | 1877 | </section> |
1737 | 1878 | ||
@@ -1754,6 +1895,27 @@ | |||
1754 | </para> | 1895 | </para> |
1755 | </section> | 1896 | </section> |
1756 | 1897 | ||
1898 | <section id='ref-classes-packagegroup'> | ||
1899 | <title>Package Groups - <filename>packagegroup.bbclass</filename></title> | ||
1900 | |||
1901 | <para> | ||
1902 | This class sets default values appropriate for package group recipes (e.g. | ||
1903 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>, | ||
1904 | <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>, | ||
1905 | <filename><link linkend='var-ALLOW_EMPTY'>ALLOW_EMPTY</link></filename>, | ||
1906 | and so forth). | ||
1907 | It is highly recommended that all package group recipes inherit this class. | ||
1908 | </para> | ||
1909 | <para> | ||
1910 | For information on how to use this class, see the | ||
1911 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>" | ||
1912 | section in the Yocto Project Development Manual. | ||
1913 | </para> | ||
1914 | <para> | ||
1915 | Previously, this class was named <filename>task.bbclass</filename>. | ||
1916 | </para> | ||
1917 | </section> | ||
1918 | |||
1757 | <section id='ref-classes-packageinfo'> | 1919 | <section id='ref-classes-packageinfo'> |
1758 | <title><filename>packageinfo.bbclass</filename></title> | 1920 | <title><filename>packageinfo.bbclass</filename></title> |
1759 | 1921 | ||
@@ -1819,6 +1981,24 @@ | |||
1819 | </para> | 1981 | </para> |
1820 | </section> | 1982 | </section> |
1821 | 1983 | ||
1984 | <section id='ref-classes-pkgconfig'> | ||
1985 | <title>Pkg-config - <filename>pkgconfig.bbclass</filename></title> | ||
1986 | |||
1987 | <para> | ||
1988 | <filename>pkg-config</filename> provides a standard way to get | ||
1989 | header and library information. | ||
1990 | This class aims to smooth integration of | ||
1991 | <filename>pkg-config</filename> into libraries that use it. | ||
1992 | </para> | ||
1993 | |||
1994 | <para> | ||
1995 | During staging, BitBake installs <filename>pkg-config</filename> data into the | ||
1996 | <filename>sysroots/</filename> directory. | ||
1997 | By making use of sysroot functionality within <filename>pkg-config</filename>, | ||
1998 | this class no longer has to manipulate the files. | ||
1999 | </para> | ||
2000 | </section> | ||
2001 | |||
1822 | <section id='ref-classes-populate-sdk'> | 2002 | <section id='ref-classes-populate-sdk'> |
1823 | <title><filename>populate_sdk.bbclass</filename></title> | 2003 | <title><filename>populate_sdk.bbclass</filename></title> |
1824 | 2004 | ||
@@ -2117,168 +2297,6 @@ | |||
2117 | </para> | 2297 | </para> |
2118 | </section> | 2298 | </section> |
2119 | 2299 | ||
2120 | <section id='ref-classes-packagegroup'> | ||
2121 | <title>Package Groups - <filename>packagegroup.bbclass</filename></title> | ||
2122 | |||
2123 | <para> | ||
2124 | This class sets default values appropriate for package group recipes (e.g. | ||
2125 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>, | ||
2126 | <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>, | ||
2127 | <filename><link linkend='var-ALLOW_EMPTY'>ALLOW_EMPTY</link></filename>, | ||
2128 | and so forth). | ||
2129 | It is highly recommended that all package group recipes inherit this class. | ||
2130 | </para> | ||
2131 | <para> | ||
2132 | For information on how to use this class, see the | ||
2133 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>" | ||
2134 | section in the Yocto Project Development Manual. | ||
2135 | </para> | ||
2136 | <para> | ||
2137 | Previously, this class was named <filename>task.bbclass</filename>. | ||
2138 | </para> | ||
2139 | </section> | ||
2140 | |||
2141 | <section id='ref-classes-package'> | ||
2142 | <title><filename>package.bbclass</filename></title> | ||
2143 | |||
2144 | <para> | ||
2145 | The packaging class (<filename>package</filename>) supports generating | ||
2146 | packages from a build's output. | ||
2147 | The core generic functionality is in the | ||
2148 | <filename>package.bbclass</filename>. | ||
2149 | The code specific to particular package types resides in these | ||
2150 | package-specific classes: | ||
2151 | <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, | ||
2152 | <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>, | ||
2153 | <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, | ||
2154 | and | ||
2155 | <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>. | ||
2156 | </para> | ||
2157 | |||
2158 | <para> | ||
2159 | You can control the list of resulting package formats by using the | ||
2160 | <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> | ||
2161 | variable defined in your <filename>conf/local.conf</filename> | ||
2162 | configuration file, which is located in the | ||
2163 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
2164 | When defining the variable, you can specify one or more package types. | ||
2165 | Since images are generated from packages, a packaging class is | ||
2166 | needed to enable image generation. | ||
2167 | The first class listed in this variable is used for image generation. | ||
2168 | </para> | ||
2169 | |||
2170 | <para> | ||
2171 | If you take the optional step to set up a repository (package feed) | ||
2172 | on the development host that can be used by Smart, you can | ||
2173 | install packages from the feed while you are running the image | ||
2174 | on the target (i.e. runtime installation of packages). | ||
2175 | For more information, see the | ||
2176 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>" | ||
2177 | section in the Yocto Project Development Manual. | ||
2178 | </para> | ||
2179 | |||
2180 | <para> | ||
2181 | The package-specific class you choose can affect build-time performance | ||
2182 | and has space ramifications. | ||
2183 | In general, building a package with IPK takes about thirty percent less | ||
2184 | time as compared to using RPM to build the same or similar package. | ||
2185 | This comparison takes into account a complete build of the package with | ||
2186 | all dependencies previously built. | ||
2187 | The reason for this discrepancy is because the RPM package manager | ||
2188 | creates and processes more | ||
2189 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> than the | ||
2190 | IPK package manager. | ||
2191 | Consequently, you might consider setting | ||
2192 | <filename>PACKAGE_CLASSES</filename> to "package_ipk" if you are | ||
2193 | building smaller systems. | ||
2194 | </para> | ||
2195 | |||
2196 | <para> | ||
2197 | Before making your package manager decision, however, you should | ||
2198 | consider some further things about using RPM: | ||
2199 | <itemizedlist> | ||
2200 | <listitem><para> | ||
2201 | RPM starts to provide more abilities than IPK due to | ||
2202 | the fact that it processes more Metadata. | ||
2203 | For example, this information includes individual file types, | ||
2204 | file checksum generation and evaluation on install, sparse file | ||
2205 | support, conflict detection and resolution for Multilib systems, | ||
2206 | ACID style upgrade, and repackaging abilities for rollbacks. | ||
2207 | </para></listitem> | ||
2208 | <listitem><para> | ||
2209 | For smaller systems, the extra space used for the Berkley | ||
2210 | Database and the amount of metadata when using RPM can affect | ||
2211 | your ability to perform on-device upgrades. | ||
2212 | </para></listitem> | ||
2213 | </itemizedlist> | ||
2214 | </para> | ||
2215 | |||
2216 | <para> | ||
2217 | You can find additional information on the effects of the package | ||
2218 | class at these two Yocto Project mailing list links: | ||
2219 | <itemizedlist> | ||
2220 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006362.html'> | ||
2221 | https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html</ulink></para></listitem> | ||
2222 | <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006363.html'> | ||
2223 | https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html</ulink></para></listitem> | ||
2224 | </itemizedlist> | ||
2225 | </para> | ||
2226 | </section> | ||
2227 | |||
2228 | <section id='ref-classes-package_deb'> | ||
2229 | <title><filename>package_deb.bbclass</filename></title> | ||
2230 | |||
2231 | <para> | ||
2232 | The Debian package manager (<filename>package_deb</filename>) class | ||
2233 | provides support for creating packages that use the | ||
2234 | <filename>.deb</filename> file format. | ||
2235 | The class ensures the packages are written out to the | ||
2236 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/deb</filename> | ||
2237 | directory in a <filename>.deb</filename> file format. | ||
2238 | <note> | ||
2239 | This package inherits the | ||
2240 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
2241 | class. | ||
2242 | </note> | ||
2243 | </para> | ||
2244 | </section> | ||
2245 | |||
2246 | <section id='ref-classes-package_rpm'> | ||
2247 | <title><filename>package_rpm.bbclass</filename></title> | ||
2248 | |||
2249 | <para> | ||
2250 | The RPM package manager (<filename>package_deb</filename>) class | ||
2251 | provides support for creating packages that use the | ||
2252 | <filename>.rpm</filename> file format. | ||
2253 | The class ensures the packages are written out to the | ||
2254 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/rpm</filename> | ||
2255 | directory in a <filename>.rpm</filename> file format. | ||
2256 | <note> | ||
2257 | This package inherits the | ||
2258 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
2259 | class. | ||
2260 | </note> | ||
2261 | </para> | ||
2262 | </section> | ||
2263 | |||
2264 | <section id='ref-classes-package_ipk'> | ||
2265 | <title><filename>package_ipk.bbclass</filename></title> | ||
2266 | |||
2267 | <para> | ||
2268 | The Itsy package manager (<filename>package_ipk</filename>) class | ||
2269 | provides support for creating packages that use the | ||
2270 | <filename>.ipk</filename> file format. | ||
2271 | The class ensures the packages are written out to the | ||
2272 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/ipk</filename> | ||
2273 | directory in a <filename>.ipk</filename> file format. | ||
2274 | <note> | ||
2275 | This package inherits the | ||
2276 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
2277 | class. | ||
2278 | </note> | ||
2279 | </para> | ||
2280 | </section> | ||
2281 | |||
2282 | <section id='ref-classes-sip'> | 2300 | <section id='ref-classes-sip'> |
2283 | <title><filename>sip.bbclass</filename></title> | 2301 | <title><filename>sip.bbclass</filename></title> |
2284 | 2302 | ||
@@ -2443,24 +2461,6 @@ | |||
2443 | </para> | 2461 | </para> |
2444 | </section> | 2462 | </section> |
2445 | 2463 | ||
2446 | <section id='ref-classes-package_tar'> | ||
2447 | <title><filename>package_tar.bbclass</filename></title> | ||
2448 | |||
2449 | <para> | ||
2450 | The consolidated Unix archive file (<filename>package_tar</filename>) | ||
2451 | class provides support for creating packages that use the | ||
2452 | <filename>.tar</filename> file format. | ||
2453 | The class ensures the packages are written out to the | ||
2454 | <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/tar</filename> | ||
2455 | directory in a <filename>.tar</filename> file format. | ||
2456 | <note> | ||
2457 | This package inherits the | ||
2458 | <link linkend='ref-classes-package'><filename>package</filename></link> | ||
2459 | class. | ||
2460 | </note> | ||
2461 | </para> | ||
2462 | </section> | ||
2463 | |||
2464 | <section id='ref-classes-rootfs*'> | 2464 | <section id='ref-classes-rootfs*'> |
2465 | <title><filename>rootfs*.bbclass</filename></title> | 2465 | <title><filename>rootfs*.bbclass</filename></title> |
2466 | 2466 | ||