diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-05-09 11:43:48 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:18:03 +0100 |
commit | 0c8da03bb1961dbd6c39faa0019d224b2679c295 (patch) | |
tree | b5f78a080e14e03c1843a99cadd976fdb21dc610 /documentation/overview-manual/overview-manual-concepts.xml | |
parent | f71afe36133f0250d1a2bedaa2edb9036aca21c3 (diff) | |
download | poky-0c8da03bb1961dbd6c39faa0019d224b2679c295.tar.gz |
overview-manual: Updated text for Image and SDK generation.
General improvements to both sections.
(From yocto-docs rev: 977fdeaf1258613c3dfc41d78c8125fdba9b2a24)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-concepts.xml')
-rw-r--r-- | documentation/overview-manual/overview-manual-concepts.xml | 70 |
1 files changed, 37 insertions, 33 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.xml b/documentation/overview-manual/overview-manual-concepts.xml index 4797878312..2a3d62c32a 100644 --- a/documentation/overview-manual/overview-manual-concepts.xml +++ b/documentation/overview-manual/overview-manual-concepts.xml | |||
@@ -1507,9 +1507,9 @@ | |||
1507 | 1507 | ||
1508 | <para> | 1508 | <para> |
1509 | Once packages are split and stored in the Package Feeds | 1509 | Once packages are split and stored in the Package Feeds |
1510 | area, the OpenEmbedded build system uses BitBake to | 1510 | area, the build system uses BitBake to generate the root |
1511 | generate the root filesystem image: | 1511 | filesystem image: |
1512 | <imagedata fileref="figures/image-generation.png" align="center" width="6in" depth="7in" /> | 1512 | <imagedata fileref="figures/image-generation.png" align="center" width="7.5in" depth="7.5in" /> |
1513 | </para> | 1513 | </para> |
1514 | 1514 | ||
1515 | <para> | 1515 | <para> |
@@ -1524,12 +1524,13 @@ | |||
1524 | <itemizedlist> | 1524 | <itemizedlist> |
1525 | <listitem><para> | 1525 | <listitem><para> |
1526 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>: | 1526 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>: |
1527 | Lists out the base set of packages to install from | 1527 | Lists out the base set of packages from which to |
1528 | the Package Feeds area. | 1528 | install from the Package Feeds area. |
1529 | </para></listitem> | 1529 | </para></listitem> |
1530 | <listitem><para> | 1530 | <listitem><para> |
1531 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>: | 1531 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>: |
1532 | Specifies packages that should not be installed. | 1532 | Specifies packages that should not be installed |
1533 | into the image. | ||
1533 | </para></listitem> | 1534 | </para></listitem> |
1534 | <listitem><para> | 1535 | <listitem><para> |
1535 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>: | 1536 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>: |
@@ -1539,9 +1540,9 @@ | |||
1539 | </para></listitem> | 1540 | </para></listitem> |
1540 | <listitem><para> | 1541 | <listitem><para> |
1541 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>: | 1542 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>: |
1542 | Specifies the package backend to use and | 1543 | Specifies the package backend (e.g. RPM, DEB, or |
1543 | consequently helps determine where to locate | 1544 | IPK) to use and consequently helps determine where |
1544 | packages within the Package Feeds area. | 1545 | to locate packages within the Package Feeds area. |
1545 | </para></listitem> | 1546 | </para></listitem> |
1546 | <listitem><para> | 1547 | <listitem><para> |
1547 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></ulink>: | 1548 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></ulink>: |
@@ -1550,8 +1551,8 @@ | |||
1550 | </para></listitem> | 1551 | </para></listitem> |
1551 | <listitem><para> | 1552 | <listitem><para> |
1552 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></ulink>: | 1553 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></ulink>: |
1553 | The final list of packages passed to the package manager | 1554 | The final list of packages passed to the package |
1554 | for installation into the image. | 1555 | manager for installation into the image. |
1555 | </para></listitem> | 1556 | </para></listitem> |
1556 | </itemizedlist> | 1557 | </itemizedlist> |
1557 | </para> | 1558 | </para> |
@@ -1574,15 +1575,15 @@ | |||
1574 | enabled for the target, the package manager's data files | 1575 | enabled for the target, the package manager's data files |
1575 | are deleted from the root filesystem. | 1576 | are deleted from the root filesystem. |
1576 | As part of the final stage of package installation, | 1577 | As part of the final stage of package installation, |
1577 | postinstall scripts that are part of the packages are run. | 1578 | post installation scripts that are part of the packages |
1578 | Any scripts that fail to run | 1579 | are run. |
1579 | on the build host are run on the target when the target | 1580 | Any scripts that fail to run on the build host are run on |
1580 | system is first booted. | 1581 | the target when the target system is first booted. |
1581 | If you are using a | 1582 | If you are using a |
1582 | <ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>read-only root filesystem</ulink>, | 1583 | <ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>read-only root filesystem</ulink>, |
1583 | all the post installation scripts must succeed during the | 1584 | all the post installation scripts must succeed on the |
1584 | package installation phase since the root filesystem is | 1585 | build host during the package installation phase since the |
1585 | read-only. | 1586 | root filesystem on the target is read-only. |
1586 | </para> | 1587 | </para> |
1587 | 1588 | ||
1588 | <para> | 1589 | <para> |
@@ -1606,7 +1607,7 @@ | |||
1606 | </para> | 1607 | </para> |
1607 | 1608 | ||
1608 | <para> | 1609 | <para> |
1609 | Optimizing processes run across the image include | 1610 | Optimizing processes that are run across the image include |
1610 | <filename>mklibs</filename>, <filename>prelink</filename>, | 1611 | <filename>mklibs</filename>, <filename>prelink</filename>, |
1611 | and any other post-processing commands as defined by the | 1612 | and any other post-processing commands as defined by the |
1612 | <ulink url='&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></ulink> | 1613 | <ulink url='&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></ulink> |
@@ -1627,12 +1628,11 @@ | |||
1627 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></ulink> | 1628 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></ulink> |
1628 | variable. | 1629 | variable. |
1629 | This variable specifies a list of functions to call before | 1630 | This variable specifies a list of functions to call before |
1630 | the OpenEmbedded build system creates the final image | 1631 | the build system creates the final image output files. |
1631 | output files. | ||
1632 | </para> | 1632 | </para> |
1633 | 1633 | ||
1634 | <para> | 1634 | <para> |
1635 | The OpenEmbedded build system dynamically creates | 1635 | The build system dynamically creates |
1636 | <filename>do_image_*</filename> tasks as needed, based | 1636 | <filename>do_image_*</filename> tasks as needed, based |
1637 | on the image types specified in the | 1637 | on the image types specified in the |
1638 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> | 1638 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> |
@@ -1671,11 +1671,10 @@ | |||
1671 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></ulink> | 1671 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></ulink> |
1672 | variable. | 1672 | variable. |
1673 | The variable specifies a list of functions to call once the | 1673 | The variable specifies a list of functions to call once the |
1674 | OpenEmbedded build system has created the final image | 1674 | build system has created the final image output files. |
1675 | output files. | ||
1676 | <note> | 1675 | <note> |
1677 | The entire image generation process is run under | 1676 | The entire image generation process is run under |
1678 | Pseudo. | 1677 | <link linkend='fakeroot-and-pseudo'>Pseudo</link>. |
1679 | Running under Pseudo ensures that the files in the | 1678 | Running under Pseudo ensures that the files in the |
1680 | root filesystem have correct ownership. | 1679 | root filesystem have correct ownership. |
1681 | </note> | 1680 | </note> |
@@ -1687,9 +1686,12 @@ | |||
1687 | 1686 | ||
1688 | <para> | 1687 | <para> |
1689 | The OpenEmbedded build system uses BitBake to generate the | 1688 | The OpenEmbedded build system uses BitBake to generate the |
1690 | Software Development Kit (SDK) installer script for both | 1689 | Software Development Kit (SDK) installer scripts for both |
1691 | the standard and extensible SDKs: | 1690 | the standard SDK and the extensible SDK (eSDK): |
1692 | <imagedata fileref="figures/sdk-generation.png" align="center" /> | 1691 | </para> |
1692 | |||
1693 | <para> | ||
1694 | <imagedata fileref="figures/sdk-generation.png" width="9in" align="center" /> | ||
1693 | <note> | 1695 | <note> |
1694 | For more information on the cross-development toolchain | 1696 | For more information on the cross-development toolchain |
1695 | generation, see the | 1697 | generation, see the |
@@ -1701,7 +1703,7 @@ | |||
1701 | task, see the | 1703 | task, see the |
1702 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" | 1704 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" |
1703 | section in the Yocto Project Application Development | 1705 | section in the Yocto Project Application Development |
1704 | and the Extensible Software Development Kit (SDK) | 1706 | and the Extensible Software Development Kit (eSDK) |
1705 | manual. | 1707 | manual. |
1706 | </note> | 1708 | </note> |
1707 | </para> | 1709 | </para> |
@@ -1709,10 +1711,12 @@ | |||
1709 | <para> | 1711 | <para> |
1710 | Like image generation, the SDK script process consists of | 1712 | Like image generation, the SDK script process consists of |
1711 | several stages and depends on many variables. | 1713 | several stages and depends on many variables. |
1712 | The <filename>do_populate_sdk</filename> and | 1714 | The |
1713 | <filename>do_populate_sdk_ext</filename> tasks use these | 1715 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></ulink> |
1714 | key variables to help create the list of packages to | 1716 | and |
1715 | actually install. | 1717 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk_ext'><filename>do_populate_sdk_ext</filename></ulink> |
1718 | tasks use these key variables to help create the list of | ||
1719 | packages to actually install. | ||
1716 | For information on the variables listed in the figure, | 1720 | For information on the variables listed in the figure, |
1717 | see the | 1721 | see the |
1718 | "<link linkend='sdk-dev-environment'>Application Development SDK</link>" | 1722 | "<link linkend='sdk-dev-environment'>Application Development SDK</link>" |