From d527a5f7ab1fe120cb1bb1cca8b74f12dd5ed0d8 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 31 May 2018 13:49:12 -0700 Subject: sdk-manual: Edits to "Packaging" section. Edits to improve writing. (From yocto-docs rev: 04d2df37ad718508c7f78a204d0d5e5fff431ce8) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/sdk-manual/sdk-extensible.xml | 33 +++++++++++++++-------------- 1 file 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 @@ do_package task, files installed during the do_install - task are split into one main package, which is almost always named - the same as the recipe, and several other packages. - This separation is done because not all of those installed files - are always useful in every image. + task are split into one main package, which is almost always + named the same as the recipe, and into several other packages. + This separation exists because not all of those installed files + are useful in every image. For example, you probably do not need any of the documentation installed in a production image. - Consequently, for each recipe the documentation files are separated - into a -doc package. - Recipes that package software that has optional modules or - plugins might do additional package splitting as well. + Consequently, for each recipe the documentation files are + separated into a -doc package. + Recipes that package software containing optional modules or + plugins might undergo additional package splitting as well. - After building a recipe you can see where files have gone by + After building a recipe, you can see where files have gone by looking in the oe-workdir/packages-split directory, which contains a subdirectory for each package. Apart from some advanced cases, the @@ -1615,17 +1615,18 @@ variables controls splitting. The PACKAGES variable lists all of the packages to be produced, while the FILES - variable specifies which files to include in each package, + variable specifies which files to include in each package by using an override to specify the package. - For example, FILES_${PN} specifies the files - to go into the main package (i.e. the main package is named the - same as the recipe and + For example, FILES_${PN} specifies the + files to go into the main package (i.e. the main package has + the same name as the recipe and ${PN} evaluates to the recipe name). - The order of the PACKAGES value is significant. + The order of the PACKAGES value is + significant. For each installed file, the first package whose - FILES value matches the file is the package - into which the file goes. + FILES value matches the file is the + package into which the file goes. Defaults exist for both the PACKAGES and FILES variables. Consequently, you might find you do not even need to set these -- cgit v1.2.3-54-g00ecf