[oe-commits] Richard Purdie : package.bbclass: Better document the different phases of operation

[git at git.openembedded.org]

Module: openembedded-core.git
Branch: master-next
Commit: 09d1754a275e247ced2c1ce420f29179b68e05d0
URL:    http://git.openembedded.org/?p=openembedded-core.git&a=commit;h=09d1754a275e247ced2c1ce420f29179b68e05d0

Author: Richard Purdie <richard.purdie at linuxfoundation.org>
Date:   Sun Feb  3 17:36:33 2013 +0000

package.bbclass: Better document the different phases of operation

Add headers to document the different phases of do_package and
make the steps clearer.

Signed-off-by: Richard Purdie <richard.purdie at linuxfoundation.org>

---

 meta/classes/package.bbclass |   16 ++++++++++++++++
 1 files changed, 16 insertions(+), 0 deletions(-)

diff --git a/meta/classes/package.bbclass b/meta/classes/package.bbclass
index d5b1ff4..7e9eecc 100644
--- a/meta/classes/package.bbclass
+++ b/meta/classes/package.bbclass
@@ -1781,6 +1781,10 @@ python do_package () {
     # as any change to rpmdeps requires this to be rerun.
     # PACKAGE_BBCLASS_VERSION = "1"
 
+    ###########################################################################
+    # Sanity test the setup
+    ###########################################################################
+
     packages = (d.getVar('PACKAGES', True) or "").split()
     if len(packages) < 1:
         bb.debug(1, "No packages to build, skipping do_package")
@@ -1796,12 +1800,24 @@ python do_package () {
         bb.error("WORKDIR, DEPLOY_DIR, D, PN and PKGD all must be defined, unable to package")
         return
 
+    ###########################################################################
+    # Setup PKGD (from D)
+    ###########################################################################
+
     for f in (d.getVar('PACKAGEBUILDPKGD', True) or '').split():
         bb.build.exec_func(f, d)
 
+    ###########################################################################
+    # Split up PKGD into PKGDEST
+    ###########################################################################
+
     for f in (d.getVar('PACKAGESPLITFUNCS', True) or '').split():
         bb.build.exec_func(f, d)
 
+    ###########################################################################
+    # Process PKGDEST
+    ###########################################################################
+
     # Build global list of files in each split package
     global pkgfiles
     pkgfiles = {}