Clean up and document gRPC-Core.podspec better

1 files changed, 15 insertions, 6 deletions

diff --git a/templates/gRPC-Core.podspec.template b/templates/gRPC-Core.podspec.template
index a634d46a48..4572a6151f 100644
--- a/templates/gRPC-Core.podspec.template
+++ b/templates/gRPC-Core.podspec.template
@@ -75,17 +75,17 @@
     s.module_name = name
     s.header_dir = name
 
-    s.module_map = 'include/grpc/module.modulemap'
-
-    s.source_files = ${(',\n' + 19*' ').join('\'%s\'' % f for f in grpc_files(libs))}
-
-    s.private_header_files = ${(',\n' + 27*' ').join('\'%s\'' % f for f in grpc_private_headers(libs))}
-
     s.header_mappings_dir = 'include/grpc'
 
     src_root = '$(PODS_ROOT)/gRPC-Core'
     # This isn't officially supported in Cocoapods. We've asked for an alternative:
     # https://github.com/CocoaPods/CocoaPods/issues/4386
+    #
+    # The src_root value of $(PODS_ROOT)/gRPC-Core assumes Cocoapods is installing this pod from its
+    # remote repo. For local development of this library, enabled by using ":path" in the Podfile,
+    # that assumption is wrong. In such case, the following settings need to be reset with the
+    # appropriate value of src_root. This can be accomplished in the pre_install hook of the Podfile;
+    # see src/objective-c/tests/Podfile for an example.
     public_build_settings = {
       'GRPC_SRC_ROOT' => src_root,
       'HEADER_SEARCH_PATHS' => '"$(inherited)" "$(GRPC_SRC_ROOT)/include"',
@@ -100,4 +100,13 @@
 
     s.libraries = 'z'
     s.dependency 'BoringSSL', '~> 3.0'
+
+    # A module map is necessary for a dynamic framework to be correctly created by Cocoapods.
+    s.module_map = 'include/grpc/module.modulemap'
+
+    # List of source files generated by a template. To save you from scrolling, this is the last part
+    # of the podspec.
+    s.source_files = ${(',\n' + 19*' ').join('\'%s\'' % f for f in grpc_files(libs))}
+
+    s.private_header_files = ${(',\n' + 27*' ').join('\'%s\'' % f for f in grpc_private_headers(libs))}
   end