Reflow paragraphs in comments.

This is intended as a clean up after the big clang-format commit
(r280751), which unfortunately resulted in many of the comment
paragraphs in LLDB being very hard to read.

FYI, the script I used was:

import textwrap
import commands
import os
import sys
import re
tmp = "%s.tmp"%sys.argv[1]
out = open(tmp, "w+")
with open(sys.argv[1], "r") as f:
  header = ""
  text = ""
  comment = re.compile(r'^( *//) ([^ ].*)$')
  special = re.compile(r'^((([A-Z]+[: ])|([0-9]+ )).*)|(.*;)$')
  for line in f:
      match = comment.match(line)
      if match and not special.match(match.group(2)):
          # skip intentionally short comments.
          if not text and len(match.group(2)) < 40:
              out.write(line)
              continue

          if text:
              text += " " + match.group(2)
          else:
              header = match.group(1)
              text = match.group(2)

          continue

      if text:
          filled = textwrap.wrap(text, width=(78-len(header)),
                                 break_long_words=False)
          for l in filled:
              out.write(header+" "+l+'\n')
              text = ""

      out.write(line)

os.rename(tmp, sys.argv[1])

Differential Revision: https://reviews.llvm.org/D46144

llvm-svn: 331197

3 files changed, 25 insertions, 34 deletions

diff --git a/lldb/source/Host/macosx/Symbols.cpp b/lldb/source/Host/macosx/Symbols.cpp
index b28d3b3e8e4..e172dd5a488 100644
--- a/lldb/source/Host/macosx/Symbols.cpp
+++ b/lldb/source/Host/macosx/Symbols.cpp
@@ -340,9 +340,8 @@ static bool GetModuleSpecInfoFromUUIDDictionary(CFDictionaryRef uuid_dict,
     std::string DBGBuildSourcePath;
     std::string DBGSourcePath;
 
-    // If DBGVersion value 2 or higher, look for
-    // DBGSourcePathRemapping dictionary and append the key-value pairs
-    // to our remappings.
+    // If DBGVersion value 2 or higher, look for DBGSourcePathRemapping
+    // dictionary and append the key-value pairs to our remappings.
     cf_dict = (CFDictionaryRef)CFDictionaryGetValue(
         (CFDictionaryRef)uuid_dict, CFSTR("DBGSourcePathRemapping"));
     if (cf_dict && CFGetTypeID(cf_dict) == CFDictionaryGetTypeID()) {
@@ -389,10 +388,9 @@ static bool GetModuleSpecInfoFromUUIDDictionary(CFDictionaryRef uuid_dict,
           }
           if (!DBGBuildSourcePath.empty() && !DBGSourcePath.empty()) {
             // In the "old style" DBGSourcePathRemapping dictionary, the
-            // DBGSourcePath values
-            // (the "values" half of key-value path pairs) were wrong.  Ignore
-            // them and use the
-            // universal DBGSourcePath string from earlier.
+            // DBGSourcePath values (the "values" half of key-value path pairs)
+            // were wrong.  Ignore them and use the universal DBGSourcePath
+            // string from earlier.
             if (new_style_source_remapping_dictionary == true &&
                 !original_DBGSourcePath_value.empty()) {
               DBGSourcePath = original_DBGSourcePath_value;
@@ -402,9 +400,9 @@ static bool GetModuleSpecInfoFromUUIDDictionary(CFDictionaryRef uuid_dict,
               DBGSourcePath = resolved_source_path.GetPath();
             }
             // With version 2 of DBGSourcePathRemapping, we can chop off the
-            // last two filename parts from the source remapping and get a
-            // more general source remapping that still works. Add this as
-            // another option in addition to the full source path remap.
+            // last two filename parts from the source remapping and get a more
+            // general source remapping that still works. Add this as another
+            // option in addition to the full source path remap.
             module_spec.GetSourceMappingList().Append(
                 ConstString(DBGBuildSourcePath.c_str()),
                 ConstString(DBGSourcePath.c_str()), true);
@@ -429,8 +427,8 @@ static bool GetModuleSpecInfoFromUUIDDictionary(CFDictionaryRef uuid_dict,
     }
 
 
-    // If we have a DBGBuildSourcePath + DBGSourcePath pair,
-    // append them to the source remappings list.
+    // If we have a DBGBuildSourcePath + DBGSourcePath pair, append them to the
+    // source remappings list.
 
     cf_str = (CFStringRef)CFDictionaryGetValue((CFDictionaryRef)uuid_dict,
                                                CFSTR("DBGBuildSourcePath"));
@@ -464,8 +462,7 @@ bool Symbols::DownloadObjectAndSymbolFile(ModuleSpec &module_spec,
   const FileSpec *file_spec_ptr = module_spec.GetFileSpecPtr();
 
   // It's expensive to check for the DBGShellCommands defaults setting, only do
-  // it once per
-  // lldb run and cache the result.
+  // it once per lldb run and cache the result.
   static bool g_have_checked_for_dbgshell_command = false;
   static const char *g_dbgshell_command = NULL;
   if (g_have_checked_for_dbgshell_command == false) {
@@ -487,8 +484,7 @@ bool Symbols::DownloadObjectAndSymbolFile(ModuleSpec &module_spec,
   }
 
   // When g_dbgshell_command is NULL, the user has not enabled the use of an
-  // external program
-  // to find the symbols, don't run it for them.
+  // external program to find the symbols, don't run it for them.
   if (force_lookup == false && g_dbgshell_command == NULL) {
     return false;
   }
diff --git a/lldb/source/Host/macosx/cfcpp/CFCMutableDictionary.cpp b/lldb/source/Host/macosx/cfcpp/CFCMutableDictionary.cpp
index 201ec9a8f5c..0c52aa3ed05 100644
--- a/lldb/source/Host/macosx/cfcpp/CFCMutableDictionary.cpp
+++ b/lldb/source/Host/macosx/cfcpp/CFCMutableDictionary.cpp
@@ -352,9 +352,8 @@ bool CFCMutableDictionary::AddValueUInt64(CFStringRef key, uint64_t value,
   CFMutableDictionaryRef dict = Dictionary(can_create);
   if (dict != NULL) {
     // The number may appear negative if the MSBit is set in "value". Due to a
-    // limitation of
-    // CFNumber, there isn't a way to have it show up otherwise as of this
-    // writing.
+    // limitation of CFNumber, there isn't a way to have it show up otherwise
+    // as of this writing.
     CFCReleaser<CFNumberRef> cf_number(
         ::CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt64Type, &value));
     if (cf_number.get()) {
@@ -371,9 +370,8 @@ bool CFCMutableDictionary::SetValueUInt64(CFStringRef key, uint64_t value,
   CFMutableDictionaryRef dict = Dictionary(can_create);
   if (dict != NULL) {
     // The number may appear negative if the MSBit is set in "value". Due to a
-    // limitation of
-    // CFNumber, there isn't a way to have it show up otherwise as of this
-    // writing.
+    // limitation of CFNumber, there isn't a way to have it show up otherwise
+    // as of this writing.
     CFCReleaser<CFNumberRef> cf_number(
         ::CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt64Type, &value));
     if (cf_number.get()) {
@@ -390,9 +388,8 @@ bool CFCMutableDictionary::AddValueDouble(CFStringRef key, double value,
   CFMutableDictionaryRef dict = Dictionary(can_create);
   if (dict != NULL) {
     // The number may appear negative if the MSBit is set in "value". Due to a
-    // limitation of
-    // CFNumber, there isn't a way to have it show up otherwise as of this
-    // writing.
+    // limitation of CFNumber, there isn't a way to have it show up otherwise
+    // as of this writing.
     CFCReleaser<CFNumberRef> cf_number(
         ::CFNumberCreate(kCFAllocatorDefault, kCFNumberDoubleType, &value));
     if (cf_number.get()) {
@@ -409,9 +406,8 @@ bool CFCMutableDictionary::SetValueDouble(CFStringRef key, double value,
   CFMutableDictionaryRef dict = Dictionary(can_create);
   if (dict != NULL) {
     // The number may appear negative if the MSBit is set in "value". Due to a
-    // limitation of
-    // CFNumber, there isn't a way to have it show up otherwise as of this
-    // writing.
+    // limitation of CFNumber, there isn't a way to have it show up otherwise
+    // as of this writing.
     CFCReleaser<CFNumberRef> cf_number(
         ::CFNumberCreate(kCFAllocatorDefault, kCFNumberDoubleType, &value));
     if (cf_number.get()) {
diff --git a/lldb/source/Host/macosx/cfcpp/CFCString.cpp b/lldb/source/Host/macosx/cfcpp/CFCString.cpp
index 0d3853c60a7..6191f873c98 100644
--- a/lldb/source/Host/macosx/cfcpp/CFCString.cpp
+++ b/lldb/source/Host/macosx/cfcpp/CFCString.cpp
@@ -88,9 +88,8 @@ const char *CFCString::UTF8(std::string &str) {
   return CFCString::UTF8(get(), str);
 }
 
-// Static function that puts a copy of the UTF8 contents of CF_STR into STR
-// and returns the C string pointer that is contained in STR when successful,
-// else
+// Static function that puts a copy of the UTF8 contents of CF_STR into STR and
+// returns the C string pointer that is contained in STR when successful, else
 // NULL is returned. This allows the std::string parameter to own the extracted
 // string,
 // and also allows that string to be returned as a C string pointer that can be
@@ -129,9 +128,9 @@ const char *CFCString::ExpandTildeInPath(const char *path,
 
 // Static function that puts a copy of the file system representation of CF_STR
 // into STR and returns the C string pointer that is contained in STR when
-// successful, else NULL is returned. This allows the std::string parameter
-// to own the extracted string, and also allows that string to be returned as
-// a C string pointer that can be used.
+// successful, else NULL is returned. This allows the std::string parameter to
+// own the extracted string, and also allows that string to be returned as a C
+// string pointer that can be used.
 
 const char *CFCString::FileSystemRepresentation(CFStringRef cf_str,
                                                 std::string &str) {