diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-05-31 13:49:12 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-06-15 11:26:38 +0100 |
commit | 162db35c6bad68f7829421a707c932158ca4237c (patch) | |
tree | 48f7e400e4f8e9ef31beb338068545557552b2fd /documentation | |
parent | 055ee2f78075a8fe00f98fc8e714b94cc2913337 (diff) | |
download | poky-162db35c6bad68f7829421a707c932158ca4237c.tar.gz |
sdk-manual: Edits to "Packaging" section.
Edits to improve writing.
(From yocto-docs rev: 470549b0d5c74f256fec2947e701a0fa3a0f6591)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.xml | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 63835f80ea..5df700bee8 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml | |||
@@ -1592,20 +1592,20 @@ | |||
1592 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package'><filename>do_package</filename></ulink> | 1592 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package'><filename>do_package</filename></ulink> |
1593 | task, files installed during the | 1593 | task, files installed during the |
1594 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink> | 1594 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink> |
1595 | task are split into one main package, which is almost always named | 1595 | task are split into one main package, which is almost always |
1596 | the same as the recipe, and several other packages. | 1596 | named the same as the recipe, and into several other packages. |
1597 | This separation is done because not all of those installed files | 1597 | This separation exists because not all of those installed files |
1598 | are always useful in every image. | 1598 | are useful in every image. |
1599 | For example, you probably do not need any of the documentation | 1599 | For example, you probably do not need any of the documentation |
1600 | installed in a production image. | 1600 | installed in a production image. |
1601 | Consequently, for each recipe the documentation files are separated | 1601 | Consequently, for each recipe the documentation files are |
1602 | into a <filename>-doc</filename> package. | 1602 | separated into a <filename>-doc</filename> package. |
1603 | Recipes that package software that has optional modules or | 1603 | Recipes that package software containing optional modules or |
1604 | plugins might do additional package splitting as well. | 1604 | plugins might undergo additional package splitting as well. |
1605 | </para> | 1605 | </para> |
1606 | 1606 | ||
1607 | <para> | 1607 | <para> |
1608 | After building a recipe you can see where files have gone by | 1608 | After building a recipe, you can see where files have gone by |
1609 | looking in the <filename>oe-workdir/packages-split</filename> | 1609 | looking in the <filename>oe-workdir/packages-split</filename> |
1610 | directory, which contains a subdirectory for each package. | 1610 | directory, which contains a subdirectory for each package. |
1611 | Apart from some advanced cases, the | 1611 | Apart from some advanced cases, the |
@@ -1615,17 +1615,18 @@ | |||
1615 | variables controls splitting. | 1615 | variables controls splitting. |
1616 | The <filename>PACKAGES</filename> variable lists all of the | 1616 | The <filename>PACKAGES</filename> variable lists all of the |
1617 | packages to be produced, while the <filename>FILES</filename> | 1617 | packages to be produced, while the <filename>FILES</filename> |
1618 | variable specifies which files to include in each package, | 1618 | variable specifies which files to include in each package by |
1619 | using an override to specify the package. | 1619 | using an override to specify the package. |
1620 | For example, <filename>FILES_${PN}</filename> specifies the files | 1620 | For example, <filename>FILES_${PN}</filename> specifies the |
1621 | to go into the main package (i.e. the main package is named the | 1621 | files to go into the main package (i.e. the main package has |
1622 | same as the recipe and | 1622 | the same name as the recipe and |
1623 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> | 1623 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> |
1624 | evaluates to the recipe name). | 1624 | evaluates to the recipe name). |
1625 | The order of the <filename>PACKAGES</filename> value is significant. | 1625 | The order of the <filename>PACKAGES</filename> value is |
1626 | significant. | ||
1626 | For each installed file, the first package whose | 1627 | For each installed file, the first package whose |
1627 | <filename>FILES</filename> value matches the file is the package | 1628 | <filename>FILES</filename> value matches the file is the |
1628 | into which the file goes. | 1629 | package into which the file goes. |
1629 | Defaults exist for both the <filename>PACKAGES</filename> and | 1630 | Defaults exist for both the <filename>PACKAGES</filename> and |
1630 | <filename>FILES</filename> variables. | 1631 | <filename>FILES</filename> variables. |
1631 | Consequently, you might find you do not even need to set these | 1632 | Consequently, you might find you do not even need to set these |