Merge pull request #27630 from ravikandhadai/minor-comment-fixes

Author: swift-ci

lib/SILOptimizer/Mandatory/OSLogOptimization.cpp

@@ -783,9 +783,9 @@ static ApplyInst *getAsOSLogMessageInit(SILInstruction *inst) {
   return nullptr;
 }
 
-/// Return true iff this function is a protocol witness for
-/// ExpressibleByStringInterpolation.init(stringInterpolation:) in OSLogMessage.
-bool isAutoGeneratedInitOfOSLogMessage(SILFunction &fun) {
+/// Return true iff the SIL function \c fun is a method of the \c OSLogMessage
+/// type.
+bool isMethodOfOSLogMessage(SILFunction &fun) {
   DeclContext *declContext = fun.getDeclContext();
   if (!declContext)
     return false;
@@ -818,11 +818,15 @@ class OSLogOptimization : public SILFunctionTransform {
       return;
     }
 
-    // Skip the auto-generated (transparent) witness method of OSLogMessage,
-    // which ends up invoking the OSLogMessage initializer:
-    // "oslog.message.init_interpolation" but without an interpolated
-    // string literal.
-    if (isAutoGeneratedInitOfOSLogMessage(fun)) {
+    // Skip methods of OSLogMessage type. This avoid unnecessary work and also
+    // avoids falsely diagnosing the auto-generated (transparent) witness method
+    // of OSLogMessage, which ends up invoking the OSLogMessage initializer:
+    // "oslog.message.init_interpolation" without an interpolated string
+    // literal that is expected by this pass.
+    // TODO: this check can be eliminated if there is a separate pass for
+    // diagnosing errors in the use of the OSLogMessage type, and this pass
+    // bails out when a use of the type is not optimizable.
+    if (isMethodOfOSLogMessage(fun)) {
       return;
     }