summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/ref-classes.xml66
-rw-r--r--documentation/ref-manual/ref-variables.xml60
2 files changed, 125 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index abb40a8e1b..74478981d0 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1393,7 +1393,7 @@
1393 </para> 1393 </para>
1394</section> 1394</section>
1395 1395
1396<section id='ref-classes-populate_sdk'> 1396<section id='ref-classes-populate-sdk'>
1397 <title><filename>populate_sdk.bbclass</filename></title> 1397 <title><filename>populate_sdk.bbclass</filename></title>
1398 1398
1399 <para> 1399 <para>
@@ -1402,6 +1402,70 @@
1402 </para> 1402 </para>
1403</section> 1403</section>
1404 1404
1405<section id='ref-classes-populate-sdk-*'>
1406 <title><filename>populate_sdk_*.bbclass</filename></title>
1407
1408 <para>
1409 The <filename>populate_sdk_*</filename> family of classes support
1410 SDK creation.
1411 This family of classes consists of the following:
1412 <itemizedlist>
1413 <listitem><para><emphasis><filename>populate_sdk_base</filename>:</emphasis>
1414 The base class supporting SDK creation under all package
1415 managers (i.e. DEB, RPM, and IPK).</para></listitem>
1416 <listitem><para><emphasis><filename>populate_sdk_deb</filename>:</emphasis>
1417 Supports creation of the SDK given the Debian package manager.
1418 </para></listitem>
1419 <listitem><para><emphasis><filename>populate_sdk_rpm</filename>:</emphasis>
1420 Supports creation of the SDK given the RPM package manager.
1421 </para></listitem>
1422 <listitem><para><emphasis><filename>populate_sdk_ipk</filename>:</emphasis>
1423 Supports creation of the SDK given the IPK package manager.
1424 </para></listitem>
1425 </itemizedlist>
1426 </para>
1427
1428 <para>
1429 The <filename>populate_sdk_base</filename> package inherits the
1430 appropriate <filename>populate_sdk_*</filename> (i.e.
1431 <filename>deb</filename>, <filename>rpm</filename>, and
1432 <filename>ipk</filename>) based on
1433 <link linkend='var-IMAGE_PKGTYPE'><filename>IMAGE_PKGTYPE</filename></link>.
1434 </para>
1435
1436 <para>
1437 The base class ensures all source and destination directories are
1438 established and then populates the SDK.
1439 After populating the SDK, the <filename>populate_sdk_base</filename>
1440 class constructs two images:
1441 <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link><filename>-nativesdk</filename>,
1442 which contains the cross-compiler and associated tooling, and the
1443 target, which contains a target root filesystem that is configured for
1444 the SDK usage.
1445 These two images reside in
1446 <link linkend='var-SDK_OUTPUT'><filename>SDK_OUTPUT</filename></link>,
1447 which consists of the following:
1448 <literallayout class='monospaced'>
1449 ${SDK_OUTPUT}/&lt;sdk_arch-nativesdk pkgs&gt;
1450 ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/&lt;target pkgs&gt;
1451 </literallayout>
1452 </para>
1453
1454 <para>
1455 Finally, the base populate SDK class creates the toolchain
1456 environment setup script, the tarball of the SDK, and the installer.
1457 </para>
1458
1459 <para>
1460 The respective <filename>populate_sdk_deb</filename>,
1461 <filename>populate_sdk_rpm</filename>, and
1462 <filename>populate_sdk_ipk</filename> classes each support the
1463 specific type of SDK.
1464 These classes are inherited by and used with the
1465 <filename>populate_sdk_base</filename> class.
1466 </para>
1467</section>
1468
1405<section id='ref-classes-perl'> 1469<section id='ref-classes-perl'>
1406 <title>Perl Modules - <filename>cpan.bbclass</filename></title> 1470 <title>Perl Modules - <filename>cpan.bbclass</filename></title>
1407 1471
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index fccffe77bb..dee179d393 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2645,6 +2645,36 @@
2645 </glossdef> 2645 </glossdef>
2646 </glossentry> 2646 </glossentry>
2647 2647
2648 <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm>
2649 <glossdef>
2650 <para>
2651 Defines the package type (DEB, RPM, IPK, or TAR) used
2652 by the OpenEmbedded build system.
2653 The variable is defined appropriately by the
2654 <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>
2655 class, the
2656 <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>
2657 class, the
2658 <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>
2659 class, or the
2660 <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>
2661 class as follows:
2662 <literallayout class='monospaced'>
2663 IMAGE_PKGTYPE ?= "deb"
2664 IMAGE_PKGTYPE ?= "ipk"
2665 IMAGE_PKGTYPE ?= "rpm"
2666 IMAGE_PKGTYPE ?= "tar"
2667 </literallayout>
2668 The
2669 <link linkend='ref-classes-populate-sdk-*'><filename>package_sdk_base</filename></link>
2670 and
2671 <link linkend='ref-classes-image'><filename>image</filename></link>
2672 classes use the <filename>IMAGE_PKGTYPE</filename> for
2673 packaging up images and SDKs.
2674 </para>
2675 </glossdef>
2676 </glossentry>
2677
2648 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> 2678 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm>
2649 <glossdef> 2679 <glossdef>
2650 <para> 2680 <para>
@@ -5436,6 +5466,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5436 </glossdef> 5466 </glossdef>
5437 </glossentry> 5467 </glossentry>
5438 5468
5469 <glossentry id='var-SDK_DIR'><glossterm>SDK_DIR</glossterm>
5470 <glossdef>
5471 <para>
5472 The parent directory used by the OpenEmbedded build system
5473 when creating SDK output.
5474 The
5475 <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
5476 class defines the variable as follows:
5477 <literallayout class='monospaced'>
5478 SDK_DIR = "${<link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>}/sdk"
5479 </literallayout>
5480 </para>
5481 </glossdef>
5482 </glossentry>
5483
5439 <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> 5484 <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
5440 <glossdef> 5485 <glossdef>
5441 <para> 5486 <para>
@@ -5455,6 +5500,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5455 </glossdef> 5500 </glossdef>
5456 </glossentry> 5501 </glossentry>
5457 5502
5503 <glossentry id='var-SDK_OUTPUT'><glossterm>SDK_OUTPUT</glossterm>
5504 <glossdef>
5505 <para>
5506 The location used by the OpenEmbedded build system when
5507 creating SDK output.
5508 The
5509 <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
5510 class defines the variable as follows:
5511 <literallayout class='monospaced'>
5512 SDK_OUTPUT = "${<link linkend='var-SDK_DIR'>SDK_DIR</link>}/image"
5513 </literallayout>
5514 </para>
5515 </glossdef>
5516 </glossentry>
5517
5458 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> 5518 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm>
5459 <glossdef> 5519 <glossdef>
5460 <para>Equivalent to 5520 <para>Equivalent to