From e2e522a6ede3165f63ad81c72f8ac6d3903f8296 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 27 Apr 2015 15:20:28 -0700 Subject: ref-manual; mega-manual: Edits to further define packaging process In response to community input where developers were attempting to locate information on how to write packages out to a directory other than ${DEPLOY_DIR}/, I updated the "Package Feeds" section, added several new DEPLOY_DIR_* variables, updated four classes, and updated four tasks. Here are some details: * Made changes to the "Package Feeds" section to provide more accurate information in the package feeds directory structure used by the build system in build/tmp. These changes included updating the figure itself and some explanatory text. * Updated the DEPLOY_DIR variable description. * Added new variable descriptions for DEPLOY_DIR_DEB, DEPLOY_DIR_IPK, DEPLOY_DIR_RPM, and DEPLOY_DIR_TAR. * Updated the related classes: package_deb, package_ipk, package_rpm, and package_tar. * Updated the related tasks: do_package_write_deb, do_package_write_ipk, do_package_write_rpm, and do_package_write_tar. Reported-by: Trieu Nguyen (From yocto-docs rev: a8d499850dec72f8decd81ec6714809c3a580ffc) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 161 ++++++++++++++++++++++++++++- 1 file changed, 160 insertions(+), 1 deletion(-) (limited to 'documentation/ref-manual/ref-variables.xml') diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index c0cae81212..ecac2b6c26 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -2686,13 +2686,55 @@ section. For more detail on the contents of the deploy directory, see the - "Images" and + "Images", + "Package Feeds", + and "Application Development SDK" sections. + DEPLOY_DIR_DEB + + DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + + + + + Points to the area that the OpenEmbedded build system uses + to place Debian packages that are ready to be used outside + of the build system. + This variable applies only when + PACKAGE_CLASSES + contains "package_deb". + + + + The BitBake configuration file initially defines the + DEPLOY_DIR_DEB variable as a + sub-folder of + DEPLOY_DIR: + + DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" + + + + + The + package_deb + class uses the + DEPLOY_DIR_DEB variable to make sure + the + do_package_write_deb + task writes Debian packages into the appropriate folder. + For more information on how packaging works, see the + "Package Feeds" + section. + + + + DEPLOY_DIR_IMAGE DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine." @@ -2724,6 +2766,123 @@ + DEPLOY_DIR_IPK + + DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + + + + + Points to the area that the OpenEmbedded build system uses + to place IPK packages that are ready to be used outside of + the build system. + This variable applies only when + PACKAGE_CLASSES + contains "package_ipk". + + + + The BitBake configuration file initially defines this + variable as a sub-folder of + DEPLOY_DIR: + + DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" + + + + + The + package_ipk + class uses the + DEPLOY_DIR_IPK variable to make sure + the + do_package_write_ipk + task writes IPK packages into the appropriate folder. + For more information on how packaging works, see the + "Package Feeds" + section. + + + + + DEPLOY_DIR_RPM + + DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + + + + + Points to the area that the OpenEmbedded build system uses + to place RPM packages that are ready to be used outside + of the build system. + This variable applies only when + PACKAGE_CLASSES + contains "package_rpm". + + + + The BitBake configuration file initially defines this + variable as a sub-folder of + DEPLOY_DIR: + + DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" + + + + + The + package_rpm + class uses the + DEPLOY_DIR_RPM variable to make sure + the + do_package_write_rpm + task writes RPM packages into the appropriate folder. + For more information on how packaging works, see the + "Package Feeds" + section. + + + + + DEPLOY_DIR_TAR + + DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + + + + + Points to the area that the OpenEmbedded build system uses + to place tarballs that are ready to be used outside of + the build system. + This variable applies only when + PACKAGE_CLASSES + contains "package_tar". + + + + The BitBake configuration file initially defines this + variable as a sub-folder of + DEPLOY_DIR: + + DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" + + + + + The + package_tar + class uses the + DEPLOY_DIR_TAR variable to make sure + the + do_package_write_tar + task writes TAR packages into the appropriate folder. + For more information on how packaging works, see the + "Package Feeds" + section. + + + + DEPLOYDIR DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files." -- cgit v1.2.3-54-g00ecf