summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml115
1 files changed, 96 insertions, 19 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 89bad481f4..70f12d0690 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1406,24 +1406,28 @@
1406 1406
1407 1407
1408<section id='ref-classes-package'> 1408<section id='ref-classes-package'>
1409 <title>Packaging - <filename>package*.bbclass</filename></title> 1409 <title><filename>package.bbclass</filename></title>
1410 1410
1411 <para> 1411 <para>
1412 The packaging classes add support for generating packages from a build's 1412 The packaging class (<filename>package</filename>) supports generating
1413 output. 1413 packages from a build's output.
1414 The core generic functionality is in <filename>package.bbclass</filename>. 1414 The core generic functionality is in the
1415 The code specific to particular package types is contained in various sub-classes such as 1415 <filename>package.bbclass</filename>.
1416 <filename>package_deb.bbclass</filename>, <filename>package_ipk.bbclass</filename>, 1416 The code specific to particular package types resides in these
1417 and <filename>package_rpm.bbclass</filename>. 1417 package-specific classes:
1418 Most users will want one or more of these classes. 1418 <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>,
1419 <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>,
1420 <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>,
1421 and
1422 <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>.
1419 </para> 1423 </para>
1420 1424
1421 <para> 1425 <para>
1422 You can control the list of resulting package formats by using the 1426 You can control the list of resulting package formats by using the
1423 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> 1427 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
1424 variable defined in the <filename>local.conf</filename> configuration file, 1428 variable defined in your <filename>conf/local.conf</filename>
1425 which is located in the <filename>conf</filename> folder of the 1429 configuration file, which is located in the
1426 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 1430 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
1427 When defining the variable, you can specify one or more package types. 1431 When defining the variable, you can specify one or more package types.
1428 Since images are generated from packages, a packaging class is 1432 Since images are generated from packages, a packaging class is
1429 needed to enable image generation. 1433 needed to enable image generation.
@@ -1441,8 +1445,8 @@
1441 </para> 1445 </para>
1442 1446
1443 <para> 1447 <para>
1444 The package class you choose can affect build-time performance and has space 1448 The package-specific class you choose can affect build-time performance
1445 ramifications. 1449 and has space ramifications.
1446 In general, building a package with IPK takes about thirty percent less 1450 In general, building a package with IPK takes about thirty percent less
1447 time as compared to using RPM to build the same or similar package. 1451 time as compared to using RPM to build the same or similar package.
1448 This comparison takes into account a complete build of the package with 1452 This comparison takes into account a complete build of the package with
@@ -1451,17 +1455,18 @@
1451 creates and processes more 1455 creates and processes more
1452 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> than the 1456 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> than the
1453 IPK package manager. 1457 IPK package manager.
1454 Consequently, you might consider setting <filename>PACKAGE_CLASSES</filename> 1458 Consequently, you might consider setting
1455 to "package_ipk" if you are building smaller systems. 1459 <filename>PACKAGE_CLASSES</filename> to "package_ipk" if you are
1460 building smaller systems.
1456 </para> 1461 </para>
1457 1462
1458 <para> 1463 <para>
1459 Before making your decision on package manager, however, you should 1464 Before making your package manager decision, however, you should
1460 consider some further things about using RPM: 1465 consider some further things about using RPM:
1461 <itemizedlist> 1466 <itemizedlist>
1462 <listitem><para> 1467 <listitem><para>
1463 RPM starts to provide more abilities than IPK due to 1468 RPM starts to provide more abilities than IPK due to
1464 the fact that it processes more metadata. 1469 the fact that it processes more Metadata.
1465 For example, this information includes individual file types, 1470 For example, this information includes individual file types,
1466 file checksum generation and evaluation on install, sparse file 1471 file checksum generation and evaluation on install, sparse file
1467 support, conflict detection and resolution for Multilib systems, 1472 support, conflict detection and resolution for Multilib systems,
@@ -1487,6 +1492,78 @@
1487 </para> 1492 </para>
1488</section> 1493</section>
1489 1494
1495<section id='ref-classes-package_deb'>
1496 <title><filename>package_deb.bbclass</filename></title>
1497
1498 <para>
1499 The Debian package manager (<filename>package_deb</filename>) class
1500 provides support for creating packages that use the
1501 <filename>.deb</filename> file format.
1502 The class ensures the packages are written out to the
1503 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/deb</filename>
1504 directory in a <filename>.deb</filename> file format.
1505 <note>
1506 This package inherits the
1507 <link linkend='ref-classes-package'><filename>package</filename></link>
1508 class.
1509 </note>
1510 </para>
1511</section>
1512
1513<section id='ref-classes-package_rpm'>
1514 <title><filename>package_rpm.bbclass</filename></title>
1515
1516 <para>
1517 The RPM package manager (<filename>package_deb</filename>) class
1518 provides support for creating packages that use the
1519 <filename>.rpm</filename> file format.
1520 The class ensures the packages are written out to the
1521 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/rpm</filename>
1522 directory in a <filename>.rpm</filename> file format.
1523 <note>
1524 This package inherits the
1525 <link linkend='ref-classes-package'><filename>package</filename></link>
1526 class.
1527 </note>
1528 </para>
1529</section>
1530
1531<section id='ref-classes-package_ipk'>
1532 <title><filename>package_ipk.bbclass</filename></title>
1533
1534 <para>
1535 The Itsy package manager (<filename>package_ipk</filename>) class
1536 provides support for creating packages that use the
1537 <filename>.ipk</filename> file format.
1538 The class ensures the packages are written out to the
1539 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/ipk</filename>
1540 directory in a <filename>.ipk</filename> file format.
1541 <note>
1542 This package inherits the
1543 <link linkend='ref-classes-package'><filename>package</filename></link>
1544 class.
1545 </note>
1546 </para>
1547</section>
1548
1549<section id='ref-classes-package_tar'>
1550 <title><filename>package_tar.bbclass</filename></title>
1551
1552 <para>
1553 The consolidated Unix archive file (<filename>package_tar</filename>)
1554 class provides support for creating packages that use the
1555 <filename>.tar</filename> file format.
1556 The class ensures the packages are written out to the
1557 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/tar</filename>
1558 directory in a <filename>.tar</filename> file format.
1559 <note>
1560 This package inherits the
1561 <link linkend='ref-classes-package'><filename>package</filename></link>
1562 class.
1563 </note>
1564 </para>
1565</section>
1566
1490<section id='ref-classes-kernel'> 1567<section id='ref-classes-kernel'>
1491 <title>Building Kernels - <filename>kernel.bbclass</filename></title> 1568 <title>Building Kernels - <filename>kernel.bbclass</filename></title>
1492 1569