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

4 files changed, 30 insertions, 30 deletions

diff --git a/lldb/source/Plugins/Process/elf-core/ProcessElfCore.cpp b/lldb/source/Plugins/Process/elf-core/ProcessElfCore.cpp
index 7418c4f74ae..e68025bea79 100644
--- a/lldb/source/Plugins/Process/elf-core/ProcessElfCore.cpp
+++ b/lldb/source/Plugins/Process/elf-core/ProcessElfCore.cpp
@@ -56,9 +56,9 @@ lldb::ProcessSP ProcessElfCore::CreateInstance(lldb::TargetSP target_sp,
                                                const FileSpec *crash_file) {
   lldb::ProcessSP process_sp;
   if (crash_file) {
-    // Read enough data for a ELF32 header or ELF64 header
-    // Note: Here we care about e_type field only, so it is safe
-    // to ignore possible presence of the header extension.
+    // Read enough data for a ELF32 header or ELF64 header Note: Here we care
+    // about e_type field only, so it is safe to ignore possible presence of
+    // the header extension.
     const size_t header_size = sizeof(llvm::ELF::Elf64_Ehdr);
 
     auto data_sp = DataBufferLLVM::CreateSliceFromPath(crash_file->GetPath(),
@@ -107,10 +107,10 @@ ProcessElfCore::ProcessElfCore(lldb::TargetSP target_sp,
 //----------------------------------------------------------------------
 ProcessElfCore::~ProcessElfCore() {
   Clear();
-  // We need to call finalize on the process before destroying ourselves
-  // to make sure all of the broadcaster cleanup goes as planned. If we
-  // destruct this class, then Process::~Process() might have problems
-  // trying to fully destroy the broadcaster.
+  // We need to call finalize on the process before destroying ourselves to
+  // make sure all of the broadcaster cleanup goes as planned. If we destruct
+  // this class, then Process::~Process() might have problems trying to fully
+  // destroy the broadcaster.
   Finalize();
 }
 
@@ -206,8 +206,8 @@ Status ProcessElfCore::DoLoadCore() {
     m_core_range_infos.Sort();
   }
 
-  // Even if the architecture is set in the target, we need to override
-  // it to match the core file which is always single arch.
+  // Even if the architecture is set in the target, we need to override it to
+  // match the core file which is always single arch.
   ArchSpec arch(m_core_module_sp->GetArchitecture());
 
   ArchSpec target_arch = GetTarget().GetArchitecture();
@@ -241,8 +241,7 @@ Status ProcessElfCore::DoLoadCore() {
   }
 
   // Core files are useless without the main executable. See if we can locate
-  // the main
-  // executable using data we found in the core file notes.
+  // the main executable using data we found in the core file notes.
   lldb::ModuleSP exe_module_sp = GetTarget().GetExecutableModule();
   if (!exe_module_sp) {
     // The first entry in the NT_FILE might be our executable
@@ -297,8 +296,8 @@ bool ProcessElfCore::IsAlive() { return true; }
 //------------------------------------------------------------------
 size_t ProcessElfCore::ReadMemory(lldb::addr_t addr, void *buf, size_t size,
                                   Status &error) {
-  // Don't allow the caching that lldb_private::Process::ReadMemory does
-  // since in core files we have it all cached our our core file anyway.
+  // Don't allow the caching that lldb_private::Process::ReadMemory does since
+  // in core files we have it all cached our our core file anyway.
   return DoReadMemory(addr, buf, size, error);
 }
 
@@ -368,17 +367,18 @@ size_t ProcessElfCore::DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
   lldb::addr_t bytes_left =
       0; // Number of bytes available in the core file from the given address
 
-  // Don't proceed if core file doesn't contain the actual data for this address range.
+  // Don't proceed if core file doesn't contain the actual data for this
+  // address range.
   if (file_start == file_end)
     return 0;
 
-  // Figure out how many on-disk bytes remain in this segment
-  // starting at the given offset
+  // Figure out how many on-disk bytes remain in this segment starting at the
+  // given offset
   if (file_end > file_start + offset)
     bytes_left = file_end - (file_start + offset);
 
-  // Figure out how many bytes we need to zero-fill if we are
-  // reading more bytes than available in the on-disk segment
+  // Figure out how many bytes we need to zero-fill if we are reading more
+  // bytes than available in the on-disk segment
   if (bytes_to_read > bytes_left) {
     zero_fill_size = bytes_to_read - bytes_left;
     bytes_to_read = bytes_left;
@@ -551,8 +551,8 @@ llvm::Error ProcessElfCore::parseFreeBSDNotes(llvm::ArrayRef<CoreNote> notes) {
 llvm::Error ProcessElfCore::parseNetBSDNotes(llvm::ArrayRef<CoreNote> notes) {
   ThreadData thread_data;
   for (const auto &note : notes) {
-    // NetBSD per-thread information is stored in notes named
-    // "NetBSD-CORE@nnn" so match on the initial part of the string.
+    // NetBSD per-thread information is stored in notes named "NetBSD-CORE@nnn"
+    // so match on the initial part of the string.
     if (!llvm::StringRef(note.info.n_name).startswith("NetBSD-CORE"))
       continue;
 
@@ -585,8 +585,8 @@ llvm::Error ProcessElfCore::parseNetBSDNotes(llvm::ArrayRef<CoreNote> notes) {
 llvm::Error ProcessElfCore::parseOpenBSDNotes(llvm::ArrayRef<CoreNote> notes) {
   ThreadData thread_data;
   for (const auto &note : notes) {
-    // OpenBSD per-thread information is stored in notes named
-    // "OpenBSD@nnn" so match on the initial part of the string.
+    // OpenBSD per-thread information is stored in notes named "OpenBSD@nnn" so
+    // match on the initial part of the string.
     if (!llvm::StringRef(note.info.n_name).startswith("OpenBSD"))
       continue;
 
@@ -749,9 +749,9 @@ ArchSpec ProcessElfCore::GetArchitecture() {
   ArchSpec target_arch = GetTarget().GetArchitecture();
   arch.MergeFrom(target_arch);
 
-  // On MIPS there is no way to differentiate betwenn 32bit and 64bit core files
-  // and this information can't be merged in from the target arch so we fail
-  // back to unconditionally returning the target arch in this config.
+  // On MIPS there is no way to differentiate betwenn 32bit and 64bit core
+  // files and this information can't be merged in from the target arch so we
+  // fail back to unconditionally returning the target arch in this config.
   if (target_arch.IsMIPS()) {
     return target_arch;
   }
diff --git a/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_mips64.cpp b/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_mips64.cpp
index e252b5a35e9..532a1f5c083 100644
--- a/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_mips64.cpp
+++ b/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_mips64.cpp
@@ -56,7 +56,7 @@ bool RegisterContextCorePOSIX_mips64::ReadRegister(const RegisterInfo *reg_info,
   if (IsGPR(reg_info->kinds[lldb::eRegisterKindLLDB])) {
     if (reg_info->byte_size == 4 && !(arch.GetMachine() == llvm::Triple::mips64el))
       // In case of 32bit core file, the register data are placed at 4 byte
-      // offset. 
+      // offset.
       offset = offset / 2;
     v = m_gpr.GetMaxU64(&offset, reg_info->byte_size);
     value = v;
diff --git a/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_x86_64.cpp b/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_x86_64.cpp
index a5c7ffda1da..a1f26d52444 100644
--- a/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_x86_64.cpp
+++ b/lldb/source/Plugins/Process/elf-core/RegisterContextPOSIXCore_x86_64.cpp
@@ -60,8 +60,8 @@ bool RegisterContextCorePOSIX_x86_64::ReadRegister(const RegisterInfo *reg_info,
   const uint8_t *src;
   size_t offset;
   const size_t fxsave_offset = reg_info->byte_offset - GetFXSAVEOffset();
-  // make the offset relative to the beginning of the FXSAVE structure
-  // because this is the data that we have (not the entire UserArea)
+  // make the offset relative to the beginning of the FXSAVE structure because
+  // this is the data that we have (not the entire UserArea)
 
   if (m_gpregset && reg_info->byte_offset < GetGPRSize()) {
     src = m_gpregset.get();
diff --git a/lldb/source/Plugins/Process/elf-core/ThreadElfCore.cpp b/lldb/source/Plugins/Process/elf-core/ThreadElfCore.cpp
index 10c1ed288b2..c808a15cfc2 100644
--- a/lldb/source/Plugins/Process/elf-core/ThreadElfCore.cpp
+++ b/lldb/source/Plugins/Process/elf-core/ThreadElfCore.cpp
@@ -292,8 +292,8 @@ Status ELFLinuxPrStatus::Parse(const DataExtractor &data,
     return error;
   }
 
-  // Read field by field to correctly account for endianess
-  // of both the core dump and the platform running lldb.
+  // Read field by field to correctly account for endianess of both the core
+  // dump and the platform running lldb.
   offset_t offset = 0;
   si_signo = data.GetU32(&offset);
   si_code = data.GetU32(&offset);