From e771b59017ab2f22687013de35c611df324cc78f Mon Sep 17 00:00:00 2001
From: Ilia K <ki.stfu@gmail.com>
Date: Mon, 23 Mar 2015 20:46:10 +0000
Subject: [PATCH] Fix/Add comments in CMICmdCmdGdbSet (MI)

llvm-svn: 233017
---
 lldb/tools/lldb-mi/MICmdCmdGdbSet.cpp | 19 ++++++++++++-------
 lldb/tools/lldb-mi/MICmdCmdGdbSet.h   |  4 ++--
 2 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/lldb/tools/lldb-mi/MICmdCmdGdbSet.cpp b/lldb/tools/lldb-mi/MICmdCmdGdbSet.cpp
index 46161d1..169d60c 100644
--- a/lldb/tools/lldb-mi/MICmdCmdGdbSet.cpp
+++ b/lldb/tools/lldb-mi/MICmdCmdGdbSet.cpp
@@ -1,4 +1,4 @@
-//===-- MICmdCmdGdbSet.cpp -------      -------------------------*- C++ -*-===//
+//===-- MICmdCmdGdbSet.cpp --------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -79,7 +79,7 @@ CMICmdCmdGdbSet::ParseArgs(void)
 }
 
 //++ ------------------------------------------------------------------------------------
-// Details: The invoker requires this function. The command does work in this function.
+// Details: The invoker requires this function. The command is executed in this function.
 //          The command is likely to communicate with the LLDB SBDebugger in here.
 // Type:    Overridden.
 // Args:    None.
@@ -132,7 +132,7 @@ CMICmdCmdGdbSet::Execute(void)
 
 //++ ------------------------------------------------------------------------------------
 // Details: The invoker requires this function. The command prepares a MI Record Result
-//          for the work carried out in the Execute().
+//          for the work carried out in the Execute() method.
 // Type:    Overridden.
 // Args:    None.
 // Return:  MIstatus::success - Functional succeeded.
@@ -142,6 +142,8 @@ CMICmdCmdGdbSet::Execute(void)
 bool
 CMICmdCmdGdbSet::Acknowledge(void)
 {
+    // Print error if option isn't recognized:
+    // ^error,msg="The request '%s' was not recognized, not implemented"
     if (!m_bGdbOptionRecognised)
     {
         const CMICmnMIValueConst miValueConst(
@@ -152,6 +154,7 @@ CMICmdCmdGdbSet::Acknowledge(void)
         return MIstatus::success;
     }
 
+    // ^done,value="%s"
     if (m_bGdbOptionFnSuccessful)
     {
         const CMICmnMIResultRecord miRecordResult(m_cmdData.strMiCmdToken, CMICmnMIResultRecord::eResultClass_Done);
@@ -159,6 +162,8 @@ CMICmdCmdGdbSet::Acknowledge(void)
         return MIstatus::success;
     }
 
+    // Print error if request failed:
+    // ^error,msg="The request '%s' failed.
     const CMICmnMIValueConst miValueConst(CMIUtilString::Format(MIRSRC(IDS_CMD_ERR_INFO_PRINTFN_FAILED), m_strGdbOptionFnError.c_str()));
     const CMICmnMIValueResult miValueResult("msg", miValueConst);
     const CMICmnMIResultRecord miRecordResult(m_cmdData.strMiCmdToken, CMICmnMIResultRecord::eResultClass_Error, miValueResult);
@@ -238,8 +243,8 @@ CMICmdCmdGdbSet::OptionFnSolibSearchPath(const CMIUtilString::VecString_t &vrWor
 }
 
 //++ ------------------------------------------------------------------------------------
-// Details: Carry out work to complete the GDB set option to prepare and send back information
-//          asked for.
+// Details: Carry out work to complete the GDB set option to prepare and send back the
+//          requested information.
 // Type:    Method.
 // Args:    None.
 // Return:  MIstatus::success - Functional succeeded.
@@ -251,8 +256,8 @@ CMICmdCmdGdbSet::OptionFnFallback(const CMIUtilString::VecString_t &vrWords)
 {
     MIunused(vrWords);
 
-    // Do nothing - intentional. This is a fallback temporary action function to do nothing.
-    // This allows the search for gdb-set options to always suceed when the option is not
+    // Do nothing - intentional. This is a fallback function to do nothing.
+    // This allows the search for gdb-set options to always succeed when the option is not
     // found (implemented).
 
     return MIstatus::success;
diff --git a/lldb/tools/lldb-mi/MICmdCmdGdbSet.h b/lldb/tools/lldb-mi/MICmdCmdGdbSet.h
index cac9525..f084002 100644
--- a/lldb/tools/lldb-mi/MICmdCmdGdbSet.h
+++ b/lldb/tools/lldb-mi/MICmdCmdGdbSet.h
@@ -1,4 +1,4 @@
-//===-- MICmdCmdGdbSet.h -------------      ---------------------*- C++ -*-===//
+//===-- MICmdCmdGdbSet.h ----------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -9,7 +9,7 @@
 
 // Overview:    CMICmdCmdGdbSet interface.
 //
-//              To implement new MI commands derive a new command class from the command base
+//              To implement new MI commands, derive a new command class from the command base
 //              class. To enable the new command for interpretation add the new command class
 //              to the command factory. The files of relevance are:
 //                  MICmdCommands.cpp
-- 
2.7.4