Merge branch 'TB-deploy' into macos-build

macbuild/ReadMe.txt

@@ -1,7 +1,7 @@
 << Draft Version 0.002>>
 
 1. Introduction:
-    This directory "macbuild" contains different files required to build KLayout
+    This directory "macbuild" contains different files required for building KLayout
     version 0.25 or later for different Max OSX including:
         * Yosemite    (10.10)
         * El Capitan  (10.11)
@@ -16,7 +16,7 @@
     standard ones bundled with the OS.
     However, you are able to choose other options like Python from Anaconda.
         :
-        :
+        : (to be updated)
         :
         :
 
@@ -26,13 +26,13 @@
         'build4mac.py', that is,
             build4mac.py -> macbuild/build4mac.py
 
-    (2) Build KLayout by appropriate options, for example, for debug-build:
+    (2) Invoke 'build4mac.py' with appropriate options, for example, for debug-build:
             $ cd /where/'build.sh'/exists
             $ ./build4mac.py -d
 
     (3) Confirm successful build.
 
-    (4) Run 'build4mac.py' again with the same options used in (2) with "-y"
+    (4) Run 'build4mac.py' again with the same options used in (2) PLUS "-y"
         to deploy executables and libraries under "klayout.app" bundle.
             $ ./build4mac.py -d -y
 

macbuild/build4mac.py

@@ -432,7 +432,8 @@ def RunMainBuildBash():
       return(0)
 
 #------------------------------------------------------------------------------
-## To deploy built binaries and depending libraries for making a bundle
+## To deploy built binaries and libraries on which those binaries depend
+#  for making a bundle (klayout.app)
 #
 # Reference: "Deploying an Application on Mac OS X" of Qt Assistant.
 #
@@ -483,11 +484,11 @@ def DeployBinariesForBundle():
   os.mkdir(MacPkgDir)
 
 
-  print( " [3] Creating the standard directory structure for a bundle ..." )
+  print( " [3] Creating the standard directory structure for 'klayout.app' bundle ..." )
   #-------------------------------------------------------------
   # [3] Create the directory skeleton for "klayout.app" bundle
   #     and command line buddy tools such as "strm2cif".
-  #     They should be stored in a directory structure like...
+  #     They are stored in the directory structure below.
   #
   #    klayout.app/+
   #                +-- Contents/+
@@ -641,7 +642,7 @@ def DeployBinariesForBundle():
       return(1)
 
 
-  print( " [8] Finally, deploying Qt's frameworks ..." )
+  print( " [8] Finally, deploying Qt's Frameworks ..." )
   #-------------------------------------------------------------
   # [8] Deploy Qt frameworks
   #-------------------------------------------------------------

macbuild/build4mac_env.py

@@ -12,7 +12,7 @@
 #===============================================================================
 
 #-----------------------------------------------------
-# [0] Xcode
+# [0] Xcode's tools
 #-----------------------------------------------------
 XcodeToolChain = { 'nameID': '/usr/bin/install_name_tool -id ',
                    'nameCH': '/usr/bin/install_name_tool -change '

macbuild/build4mac_util.py

@@ -24,7 +24,7 @@ from build4mac_env  import *
 
 #------------------------------------------------------------------------------
 ## To decompose strings obtained by 'otool -L <*.dylib>' command and to
-#  generate a dictionary of library dependency.
+#  generate a dictionary of KLayout's inter-library dependency.
 #
 # @param[in] depstr   strings that tell dependency such as:
 #
@@ -34,6 +34,8 @@ from build4mac_env  import *
 #    libklayout_gsi.0.dylib (compatibility version 0.25.0, current version 0.25.0)
 #    libklayout_laybasic.0.dylib (compatibility version 0.25.0, current version 0.25.0)
 #    libklayout_db.0.dylib (compatibility version 0.25.0, current version 0.25.0)
+#      :
+#      :
 #
 # @return a dictionary
 #------------------------------------------------------------------------------
@@ -65,7 +67,7 @@ def PrintLibraryDependencyDictionary( depdic, namedic ):
       print( "    %s" % item )
 
 #------------------------------------------------------------------------------
-## To set and change identification name of dylib
+## To set and change identification name of KLayout's dylib
 #
 # @param[in] libdic  inter-library dependency dictionary
 #