Add comments

...

Author: helje5

scripts/swift-lambda-build

@@ -326,17 +326,22 @@ fi
 
 # ********** Archive ****************************
 
+# Drop and recreate the LAMBDA_BUILD_DIR (defaults to `.build/lambda`)
 prepareLambdaDir() {
   rm   -rf "${LAMBDA_BUILD_DIR}"
   mkdir -p "${LAMBDA_BUILD_DIR}"
 }
 
+# Clone copy the file passed in Argument $1 into the LAMBDA_BUILD_DIR (defaults
+# to `.build/lambda`)
 embedInZip() {
   # a - preserve attributes
   # c - clone
   # H - follow symbolic links
   cp -acH "$1" "${LAMBDA_BUILD_DIR}/"
 }
+# This embeds a subdirectory contains within the product directory in the
+# Zip directory. For example Sources/MacroApp/public.
 embedSourcesDirInZip() {
   if [[ -d "${SPM_PACKAGE_SOURCE_DIR}/Sources/${PRODUCT_NAME}/$1" ]]; then
     if [[ "x${verbose}" = "xyes" ]]; then
@@ -351,6 +356,9 @@ embedSourcesDirInZip() {
   fi
 }
 
+# This copies dylibs required by the built product (in .build/x86_64.../release)
+# to the zip.
+# It uses `objdump` to discover the required libs.
 copySharedLibraryDependencies() {
   XTOOLCHAIN_SDK=$(jq -r ".sdk" ${SPM_DESTINATION_FILE})
   USED_LIBS=$(objdump -p ${SPM_BUILD_DIR}/${TARGET}/${SPM_BUILD_CONFIG}/${PRODUCT_NAME} \
@@ -396,18 +404,25 @@ copySharedLibraryDependencies() {
   done
 }
 
+# This just copies the executable product into the LAMBDA_BUILD_DIR
 copyBuildProduct() {
   cp -ac "${SPM_EXECUTABLE_BUILD_PRODUCT}" \
          "${LAMBDA_BUILD_DIR}/${LAMBDA_EXECUTABLE_NAME}"
 }
 
+# This copies Macro-like product resource directories into the zip. Those live
+# alongside the source files, for example Sources/MacroApp/public (and /view).
+# Note: do not mix up w/ SPM resource directories, which work differently.
 copyProductResources() {
   # make configurable somehow
+  # defaults to: views public
   for dir in ${LAMBDA_SOURCE_RELATIVE_RESOURCEDIRS}; do
     embedSourcesDirInZip $dir
   done
 }
 
+# This zips the LAMBDA_BUILD_DIR (.build/lambda) into a zipfile for 
+# distribution.
 zipBuildDir() {
   # X          - exclude extended attributes
   # 9          - higher compression