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

1 files changed, 28 insertions, 30 deletions

diff --git a/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.cpp b/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.cpp
index 6b3d5f6c117..95659725ce2 100644
--- a/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.cpp
+++ b/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.cpp
@@ -142,8 +142,8 @@ static Status ForkChildForPTraceDebugging(const char *path, char const *argv[],
   }
 
   // Use a fork that ties the child process's stdin/out/err to a pseudo
-  // terminal so we can read it in our MachProcess::STDIOThread
-  // as unbuffered io.
+  // terminal so we can read it in our MachProcess::STDIOThread as unbuffered
+  // io.
   PseudoTerminal pty;
   char fork_error[256];
   memset(fork_error, 0, sizeof(fork_error));
@@ -167,12 +167,12 @@ static Status ForkChildForPTraceDebugging(const char *path, char const *argv[],
     // Get BSD signals as mach exceptions.
     ::ptrace(PT_SIGEXC, 0, 0, 0);
 
-    // If our parent is setgid, lets make sure we don't inherit those
-    // extra powers due to nepotism.
+    // If our parent is setgid, lets make sure we don't inherit those extra
+    // powers due to nepotism.
     if (::setgid(getgid()) == 0) {
-      // Let the child have its own process group. We need to execute
-      // this call in both the child and parent to avoid a race
-      // condition between the two processes.
+      // Let the child have its own process group. We need to execute this call
+      // in both the child and parent to avoid a race condition between the two
+      // processes.
 
       // Set the child process group to match its pid.
       ::setpgid(0, 0);
@@ -183,23 +183,22 @@ static Status ForkChildForPTraceDebugging(const char *path, char const *argv[],
       // Turn this process into the given executable.
       ::execv(path, (char *const *)argv);
     }
-    // Exit with error code. Child process should have taken
-    // over in above exec call and if the exec fails it will
-    // exit the child process below.
+    // Exit with error code. Child process should have taken over in above exec
+    // call and if the exec fails it will exit the child process below.
     ::exit(127);
   } else {
     //--------------------------------------------------------------
     // Parent process
     //--------------------------------------------------------------
-    // Let the child have its own process group. We need to execute
-    // this call in both the child and parent to avoid a race condition
-    // between the two processes.
+    // Let the child have its own process group. We need to execute this call
+    // in both the child and parent to avoid a race condition between the two
+    // processes.
 
     // Set the child process group to match its pid
     ::setpgid(*pid, *pid);
     if (pty_fd) {
-      // Release our master pty file descriptor so the pty class doesn't
-      // close it and so we can continue to use it in our STDIO thread
+      // Release our master pty file descriptor so the pty class doesn't close
+      // it and so we can continue to use it in our STDIO thread
       *pty_fd = pty.ReleaseMasterFileDescriptor();
     }
   }
@@ -302,8 +301,7 @@ static Status PosixSpawnChildForPTraceDebugging(const char *path,
     return error;
   }
 
-  // Ensure we clean up the spawnattr structure however we exit this
-  // function.
+  // Ensure we clean up the spawnattr structure however we exit this function.
   std::unique_ptr<posix_spawnattr_t, int (*)(posix_spawnattr_t *)> spawnattr_up(
       &attr, ::posix_spawnattr_destroy);
 
@@ -332,9 +330,9 @@ static Status PosixSpawnChildForPTraceDebugging(const char *path,
 
 #if !defined(__arm__)
 
-  // We don't need to do this for ARM, and we really shouldn't now that we
-  // have multiple CPU subtypes and no posix_spawnattr call that allows us
-  // to set which CPU subtype to launch...
+  // We don't need to do this for ARM, and we really shouldn't now that we have
+  // multiple CPU subtypes and no posix_spawnattr call that allows us to set
+  // which CPU subtype to launch...
   cpu_type_t desired_cpu_type = launch_info.GetArchitecture().GetMachOCPUType();
   if (desired_cpu_type != LLDB_INVALID_CPUTYPE) {
     size_t ocount = 0;
@@ -374,10 +372,10 @@ static Status PosixSpawnChildForPTraceDebugging(const char *path,
                   int (*)(posix_spawn_file_actions_t *)>
       file_actions_up(&file_actions, ::posix_spawn_file_actions_destroy);
 
-  // We assume the caller has setup the file actions appropriately.  We
-  // are not in the business of figuring out what we really need here.
-  // lldb-server will have already called FinalizeFileActions() as well
-  // to button these up properly.
+  // We assume the caller has setup the file actions appropriately.  We are not
+  // in the business of figuring out what we really need here. lldb-server will
+  // have already called FinalizeFileActions() as well to button these up
+  // properly.
   const size_t num_actions = launch_info.GetNumFileActions();
   for (size_t action_index = 0; action_index < num_actions; ++action_index) {
     const FileAction *const action =
@@ -533,8 +531,8 @@ Status LaunchInferior(ProcessLaunchInfo &launch_info, int *pty_master_fd,
     if (error.Success()) {
       launch_info.SetProcessID(static_cast<lldb::pid_t>(pid));
     } else {
-      // Reset any variables that might have been set during a failed
-      // launch attempt.
+      // Reset any variables that might have been set during a failed launch
+      // attempt.
       if (pty_master_fd)
         *pty_master_fd = -1;
 
@@ -616,8 +614,8 @@ Status LaunchInferior(ProcessLaunchInfo &launch_info, int *pty_master_fd,
       if (pty_master_fd)
         *pty_master_fd = launch_info.GetPTY().ReleaseMasterFileDescriptor();
     } else {
-      // Reset any variables that might have been set during a failed
-      // launch attempt.
+      // Reset any variables that might have been set during a failed launch
+      // attempt.
       if (pty_master_fd)
         *pty_master_fd = -1;
 
@@ -636,8 +634,8 @@ Status LaunchInferior(ProcessLaunchInfo &launch_info, int *pty_master_fd,
   }
 
   if (launch_info.GetProcessID() == LLDB_INVALID_PROCESS_ID) {
-    // If we don't have a valid process ID and no one has set the error,
-    // then return a generic error.
+    // If we don't have a valid process ID and no one has set the error, then
+    // return a generic error.
     if (error.Success())
       error.SetErrorStringWithFormat("%s(): failed to launch, no reason "
                                      "specified",