diff options
| author | Kate Stone <katherine.stone@apple.com> | 2016-07-14 22:03:10 +0000 |
|---|---|---|
| committer | Kate Stone <katherine.stone@apple.com> | 2016-07-14 22:03:10 +0000 |
| commit | 7428a18c1e9ba131022184746889b69308c0180d (patch) | |
| tree | 0f7bd6a83507282c28d2309627a2f07165fb45b1 /lldb/source/Commands | |
| parent | 36f57fbc66a70bc427805e47605d720c16dcf522 (diff) | |
| download | llvm-7428a18c1e9ba131022184746889b69308c0180d.zip llvm-7428a18c1e9ba131022184746889b69308c0180d.tar.gz llvm-7428a18c1e9ba131022184746889b69308c0180d.tar.bz2 | |
LLDB help content has accumulated over time without a recent attempt to
review it for consistency, accuracy, and clarity. These changes attempt to
address all of the above while keeping the text relatively terse.
<rdar://problem/24868841>
llvm-svn: 275485
Diffstat (limited to 'lldb/source/Commands')
27 files changed, 484 insertions, 670 deletions
diff --git a/lldb/source/Commands/CommandObjectApropos.cpp b/lldb/source/Commands/CommandObjectApropos.cpp index 0787d12..29e1f14 100644 --- a/lldb/source/Commands/CommandObjectApropos.cpp +++ b/lldb/source/Commands/CommandObjectApropos.cpp @@ -25,11 +25,8 @@ using namespace lldb_private; // CommandObjectApropos //------------------------------------------------------------------------- -CommandObjectApropos::CommandObjectApropos (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "apropos", - "Find a list of debugger commands related to a particular word/subject.", - nullptr) +CommandObjectApropos::CommandObjectApropos(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "apropos", "List debugger commands related to a word or subject.", nullptr) { CommandArgumentEntry arg; CommandArgumentData search_word_arg; diff --git a/lldb/source/Commands/CommandObjectBreakpoint.cpp b/lldb/source/Commands/CommandObjectBreakpoint.cpp index f8dd6ef..6a71389 100644 --- a/lldb/source/Commands/CommandObjectBreakpoint.cpp +++ b/lldb/source/Commands/CommandObjectBreakpoint.cpp @@ -1294,18 +1294,20 @@ protected: class CommandObjectBreakpointDisable : public CommandObjectParsed { public: - CommandObjectBreakpointDisable (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "breakpoint disable", - "Disable the specified breakpoint(s) without removing them. If none are specified, disable all breakpoints.", - nullptr) + CommandObjectBreakpointDisable(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "breakpoint disable", "Disable the specified breakpoint(s) without deleting " + "them. If none are specified, disable all " + "breakpoints.", + nullptr) { - SetHelpLong( -"Disable the specified breakpoint(s) without removing them. \ -If none are specified, disable all breakpoints." R"( + SetHelpLong("Disable the specified breakpoint(s) without deleting them. \ +If none are specified, disable all breakpoints." + R"( -)" "Note: disabling a breakpoint will cause none of its locations to be hit \ -regardless of whether they are enabled or disabled. After the sequence:" R"( +)" + "Note: disabling a breakpoint will cause none of its locations to be hit \ +regardless of whether individual locations are enabled or disabled. After the sequence:" + R"( (lldb) break disable 1 (lldb) break enable 1.1 @@ -1315,10 +1317,10 @@ execution will NOT stop at location 1.1. To achieve that, type: (lldb) break disable 1.* (lldb) break enable 1.1 -)" "The first command disables all the locations of breakpoint 1, \ -the second re-enables the first location." - ); - +)" + "The first command disables all locations for breakpoint 1, \ +the second re-enables the first location."); + CommandArgumentEntry arg; CommandObject::AddIDsArgumentData(arg, eArgTypeBreakpointID, eArgTypeBreakpointIDRange); // Add the entry for the first argument for this command to the object's arguments vector. @@ -1566,7 +1568,7 @@ protected: } else { - result.AppendError ("Invalid breakpoint id."); + result.AppendError("Invalid breakpoint ID."); result.SetStatus (eReturnStatusFailed); } } @@ -1616,12 +1618,11 @@ public: eClearTypeFileAndLine } BreakpointClearType; - CommandObjectBreakpointClear (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "breakpoint clear", - "Clears a breakpoint or set of breakpoints in the executable.", - "breakpoint clear <cmd-options>"), - m_options (interpreter) + CommandObjectBreakpointClear(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "breakpoint clear", + "Delete or disable breakpoints matching the specified source file and line.", + "breakpoint clear <cmd-options>"), + m_options(interpreter) { } @@ -1991,13 +1992,13 @@ CommandObjectBreakpointDelete::CommandOptions::g_option_table[] = // CommandObjectBreakpointName //------------------------------------------------------------------------- -static OptionDefinition -g_breakpoint_name_options[] = -{ - { LLDB_OPT_SET_1, false, "name", 'N', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeBreakpointName, "Specifies a breakpoint name to use."}, - { LLDB_OPT_SET_2, false, "breakpoint-id", 'B', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeBreakpointID, "Specify a breakpoint id to use."}, - { LLDB_OPT_SET_ALL, false, "dummy-breakpoints", 'D', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, - "Operate on Dummy breakpoints - i.e. breakpoints set before a file is provided, which prime new targets."}, +static OptionDefinition g_breakpoint_name_options[] = { + {LLDB_OPT_SET_1, false, "name", 'N', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeBreakpointName, + "Specifies a breakpoint name to use."}, + {LLDB_OPT_SET_2, false, "breakpoint-id", 'B', OptionParser::eRequiredArgument, nullptr, nullptr, 0, + eArgTypeBreakpointID, "Specify a breakpoint ID to use."}, + {LLDB_OPT_SET_ALL, false, "dummy-breakpoints", 'D', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, + "Operate on Dummy breakpoints - i.e. breakpoints set before a file is provided, which prime new targets."}, }; class BreakpointNameOptionGroup : public OptionGroup { @@ -2347,11 +2348,9 @@ private: class CommandObjectBreakpointName : public CommandObjectMultiword { public: - CommandObjectBreakpointName (CommandInterpreter &interpreter) : - CommandObjectMultiword(interpreter, - "name", - "A set of commands to manage name tags for breakpoints", - "breakpoint name <command> [<command-options>]") + CommandObjectBreakpointName(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "name", "Commands to manage name tags for breakpoints", + "breakpoint name <subcommand> [<command-options>]") { CommandObjectSP add_command_object (new CommandObjectBreakpointNameAdd (interpreter)); CommandObjectSP delete_command_object (new CommandObjectBreakpointNameDelete (interpreter)); @@ -2370,11 +2369,10 @@ public: //------------------------------------------------------------------------- #pragma mark MultiwordBreakpoint -CommandObjectMultiwordBreakpoint::CommandObjectMultiwordBreakpoint (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "breakpoint", - "A set of commands for operating on breakpoints. Also see _regexp-break.", - "breakpoint <command> [<command-options>]") +CommandObjectMultiwordBreakpoint::CommandObjectMultiwordBreakpoint(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "breakpoint", + "Commands for operating on breakpoints (see 'help b' for shorthand.)", + "breakpoint <subcommand> [<command-options>]") { CommandObjectSP list_command_object (new CommandObjectBreakpointList (interpreter)); CommandObjectSP enable_command_object (new CommandObjectBreakpointEnable (interpreter)); @@ -2481,7 +2479,8 @@ CommandObjectMultiwordBreakpoint::VerifyIDs (Args &args, else { i = valid_ids->GetSize() + 1; - result.AppendErrorWithFormat ("'%d' is not a currently valid breakpoint id.\n", cur_bp_id.GetBreakpointID()); + result.AppendErrorWithFormat("'%d' is not a currently valid breakpoint ID.\n", + cur_bp_id.GetBreakpointID()); result.SetStatus (eReturnStatusFailed); } } diff --git a/lldb/source/Commands/CommandObjectBreakpointCommand.cpp b/lldb/source/Commands/CommandObjectBreakpointCommand.cpp index b12992f..57572c8 100644 --- a/lldb/source/Commands/CommandObjectBreakpointCommand.cpp +++ b/lldb/source/Commands/CommandObjectBreakpointCommand.cpp @@ -36,14 +36,13 @@ class CommandObjectBreakpointCommandAdd : public IOHandlerDelegateMultiline { public: - CommandObjectBreakpointCommandAdd (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "add", - "Add a set of commands to a breakpoint, to be executed whenever the breakpoint is hit." - " If no breakpoint is specified, adds the commands to the last created breakpoint.", - nullptr), - IOHandlerDelegateMultiline ("DONE", IOHandlerDelegate::Completion::LLDBCommand), - m_options (interpreter) + CommandObjectBreakpointCommandAdd(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "add", + "Add LLDB commands to a breakpoint, to be executed whenever the breakpoint is hit." + " If no breakpoint is specified, adds the commands to the last created breakpoint.", + nullptr), + IOHandlerDelegateMultiline("DONE", IOHandlerDelegate::Completion::LLDBCommand), + m_options(interpreter) { SetHelpLong ( R"( @@ -855,11 +854,11 @@ protected: // CommandObjectBreakpointCommand //------------------------------------------------------------------------- -CommandObjectBreakpointCommand::CommandObjectBreakpointCommand (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "command", - "A set of commands for adding, removing and examining bits of code to be executed when the breakpoint is hit (breakpoint 'commands').", - "command <sub-command> [<sub-command-options>] <breakpoint-id>") +CommandObjectBreakpointCommand::CommandObjectBreakpointCommand(CommandInterpreter &interpreter) + : CommandObjectMultiword( + interpreter, "command", + "Commands for adding, removing and listing LLDB commands executed when a breakpoint is hit.", + "command <sub-command> [<sub-command-options>] <breakpoint-id>") { CommandObjectSP add_command_object (new CommandObjectBreakpointCommandAdd (interpreter)); CommandObjectSP delete_command_object (new CommandObjectBreakpointCommandDelete (interpreter)); diff --git a/lldb/source/Commands/CommandObjectBugreport.cpp b/lldb/source/Commands/CommandObjectBugreport.cpp index 3d00cb8..db8c06c 100644 --- a/lldb/source/Commands/CommandObjectBugreport.cpp +++ b/lldb/source/Commands/CommandObjectBugreport.cpp @@ -130,11 +130,9 @@ private: // CommandObjectMultiwordBugreport //------------------------------------------------------------------------- -CommandObjectMultiwordBugreport::CommandObjectMultiwordBugreport(CommandInterpreter &interpreter) : - CommandObjectMultiword(interpreter, - "bugreport", - "Set of commands for creating domain specific bugreports.", - "bugreport <subcommand> [<subcommand-options>]") +CommandObjectMultiwordBugreport::CommandObjectMultiwordBugreport(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "bugreport", "Commands for creating domain-specific bug reports.", + "bugreport <subcommand> [<subcommand-options>]") { LoadSubCommand("unwind", CommandObjectSP(new CommandObjectBugreportUnwind(interpreter))); diff --git a/lldb/source/Commands/CommandObjectCommands.cpp b/lldb/source/Commands/CommandObjectCommands.cpp index 5dae9a0..dd2fd9a 100644 --- a/lldb/source/Commands/CommandObjectCommands.cpp +++ b/lldb/source/Commands/CommandObjectCommands.cpp @@ -235,12 +235,10 @@ CommandObjectCommandsHistory::CommandOptions::g_option_table[] = class CommandObjectCommandsSource : public CommandObjectParsed { public: - CommandObjectCommandsSource(CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "command source", - "Read in debugger commands from the file <filename> and execute them.", - nullptr), - m_options (interpreter) + CommandObjectCommandsSource(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "command source", "Read and execute LLDB commands from the file <filename>.", + nullptr), + m_options(interpreter) { CommandArgumentEntry arg; CommandArgumentData file_arg; @@ -508,13 +506,11 @@ public: return &m_option_group; } - CommandObjectCommandsAlias (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "command alias", - "Allow users to define their own debugger command abbreviations.", - nullptr), - m_option_group(interpreter), - m_command_options() + CommandObjectCommandsAlias(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "command alias", "Define a custom command in terms of an existing command.", + nullptr), + m_option_group(interpreter), + m_command_options() { m_option_group.Append(&m_command_options); m_option_group.Finalize(); @@ -924,11 +920,9 @@ CommandObjectCommandsAlias::CommandOptions::g_option_table[] = class CommandObjectCommandsUnalias : public CommandObjectParsed { public: - CommandObjectCommandsUnalias (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "command unalias", - "Allow the user to remove/delete a user-defined command abbreviation.", - nullptr) + CommandObjectCommandsUnalias(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "command unalias", + "Delete one or more custom commands defined by 'command alias'.", nullptr) { CommandArgumentEntry arg; CommandArgumentData alias_arg; @@ -1014,11 +1008,9 @@ protected: class CommandObjectCommandsDelete : public CommandObjectParsed { public: - CommandObjectCommandsDelete (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "command delete", - "Allow the user to delete user-defined regular expression, python or multi-word commands.", - nullptr) + CommandObjectCommandsDelete(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "command delete", + "Delete one or more custom commands defined by 'command regex'.", nullptr) { CommandArgumentEntry arg; CommandArgumentData alias_arg; @@ -1075,7 +1067,9 @@ protected: } else { - result.AppendErrorWithFormat ("must call '%s' with one or more valid user defined regular expression, python or multi-word command names", GetCommandName ()); + result.AppendErrorWithFormat( + "must call '%s' with one or more valid user defined regular expression command names", + GetCommandName()); result.SetStatus (eReturnStatusFailed); } @@ -1093,13 +1087,12 @@ class CommandObjectCommandsAddRegex : public IOHandlerDelegateMultiline { public: - CommandObjectCommandsAddRegex (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "command regex", - "Allow the user to create a regular expression command.", - "command regex <cmd-name> [s/<regex>/<subst>/ ...]"), - IOHandlerDelegateMultiline ("", IOHandlerDelegate::Completion::LLDBCommand), - m_options (interpreter) + CommandObjectCommandsAddRegex(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "command regex", + "Define a custom command in terms of existing commands by matching regular expressions.", + "command regex <cmd-name> [s/<regex>/<subst>/ ...]"), + IOHandlerDelegateMultiline("", IOHandlerDelegate::Completion::LLDBCommand), + m_options(interpreter) { SetHelpLong(R"( )" "This command allows the user to create powerful regular expression commands \ @@ -2266,11 +2259,10 @@ protected: class CommandObjectMultiwordCommandsScript : public CommandObjectMultiword { public: - CommandObjectMultiwordCommandsScript (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "command script", - "A set of commands for managing or customizing script commands.", - "command script <subcommand> [<subcommand-options>]") + CommandObjectMultiwordCommandsScript(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "command script", + "Commands for managing custom commands implemented by interpreter scripts.", + "command script <subcommand> [<subcommand-options>]") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectCommandsScriptAdd (interpreter))); LoadSubCommand ("delete", CommandObjectSP (new CommandObjectCommandsScriptDelete (interpreter))); @@ -2288,11 +2280,9 @@ public: // CommandObjectMultiwordCommands //------------------------------------------------------------------------- -CommandObjectMultiwordCommands::CommandObjectMultiwordCommands (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "command", - "A set of commands for managing or customizing the debugger commands.", - "command <subcommand> [<subcommand-options>]") +CommandObjectMultiwordCommands::CommandObjectMultiwordCommands(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "command", "Commands for managing custom LLDB commands.", + "command <subcommand> [<subcommand-options>]") { LoadSubCommand ("source", CommandObjectSP (new CommandObjectCommandsSource (interpreter))); LoadSubCommand ("alias", CommandObjectSP (new CommandObjectCommandsAlias (interpreter))); diff --git a/lldb/source/Commands/CommandObjectDisassemble.cpp b/lldb/source/Commands/CommandObjectDisassemble.cpp index 9e01fe8..07a847a 100644 --- a/lldb/source/Commands/CommandObjectDisassemble.cpp +++ b/lldb/source/Commands/CommandObjectDisassemble.cpp @@ -257,12 +257,12 @@ CommandObjectDisassemble::CommandOptions::g_option_table[] = // CommandObjectDisassemble //------------------------------------------------------------------------- -CommandObjectDisassemble::CommandObjectDisassemble (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "disassemble", - "Disassemble bytes in the current function, or elsewhere in the executable program as specified by the user.", - "disassemble [<cmd-options>]"), - m_options (interpreter) +CommandObjectDisassemble::CommandObjectDisassemble(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "disassemble", "Disassemble specified instructions in the current target. " + "Defaults to the current function for the current thread and " + "stack frame.", + "disassemble [<cmd-options>]"), + m_options(interpreter) { } diff --git a/lldb/source/Commands/CommandObjectExpression.cpp b/lldb/source/Commands/CommandObjectExpression.cpp index 22d58fd..f2bd3ed 100644 --- a/lldb/source/Commands/CommandObjectExpression.cpp +++ b/lldb/source/Commands/CommandObjectExpression.cpp @@ -219,19 +219,18 @@ CommandObjectExpression::CommandOptions::GetDefinitions () return g_option_table; } -CommandObjectExpression::CommandObjectExpression (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "expression", - "Evaluate an expression in the current program context, using user defined variables and variables currently in scope.", - nullptr, - eCommandProcessMustBePaused | eCommandTryTargetAPILock), - IOHandlerDelegate (IOHandlerDelegate::Completion::Expression), - m_option_group (interpreter), - m_format_options (eFormatDefault), - m_repl_option (LLDB_OPT_SET_1, false, "repl", 'r', "Drop into REPL", false, true), - m_command_options (), - m_expr_line_count (0), - m_expr_lines () +CommandObjectExpression::CommandObjectExpression(CommandInterpreter &interpreter) + : CommandObjectRaw( + interpreter, "expression", + "Evaluate an expression on the current thread. Displays any returned value with LLDB's default formatting.", + nullptr, eCommandProcessMustBePaused | eCommandTryTargetAPILock), + IOHandlerDelegate(IOHandlerDelegate::Completion::Expression), + m_option_group(interpreter), + m_format_options(eFormatDefault), + m_repl_option(LLDB_OPT_SET_1, false, "repl", 'r', "Drop into REPL", false, true), + m_command_options(), + m_expr_line_count(0), + m_expr_lines() { SetHelpLong( R"( diff --git a/lldb/source/Commands/CommandObjectFrame.cpp b/lldb/source/Commands/CommandObjectFrame.cpp index cc70cf2..cd436df 100644 --- a/lldb/source/Commands/CommandObjectFrame.cpp +++ b/lldb/source/Commands/CommandObjectFrame.cpp @@ -58,15 +58,11 @@ using namespace lldb_private; class CommandObjectFrameInfo : public CommandObjectParsed { public: - CommandObjectFrameInfo (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "frame info", - "List information about the currently selected frame in the current thread.", - "frame info", - eCommandRequiresFrame | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ) + CommandObjectFrameInfo(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "frame info", + "List information about the current stack frame in the current thread.", "frame info", + eCommandRequiresFrame | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched | + eCommandProcessMustBePaused) { } @@ -141,17 +137,14 @@ public: static OptionDefinition g_option_table[]; int32_t relative_frame_offset; }; - - CommandObjectFrameSelect (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "frame select", - "Select a frame by index from within the current thread and make it the current frame.", - nullptr, - eCommandRequiresThread | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ), - m_options (interpreter) + + CommandObjectFrameSelect(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "frame select", + "Select the current stack frame by index from within the current thread (see 'thread backtrace'.)", + nullptr, eCommandRequiresThread | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched | + eCommandProcessMustBePaused), + m_options(interpreter) { CommandArgumentEntry arg; CommandArgumentData index_arg; @@ -199,7 +192,7 @@ protected: if (frame_idx == 0) { //If you are already at the bottom of the stack, then just warn and don't reset the frame. - result.AppendError("Already at the bottom of the stack"); + result.AppendError("Already at the bottom of the stack."); result.SetStatus(eReturnStatusFailed); return false; } @@ -219,7 +212,7 @@ protected: if (frame_idx == num_frames - 1) { //If we are already at the top of the stack, just warn and don't reset the frame. - result.AppendError("Already at the top of the stack"); + result.AppendError("Already at the top of the stack."); result.SetStatus(eReturnStatusFailed); return false; } @@ -237,7 +230,7 @@ protected: frame_idx = StringConvert::ToUInt32 (frame_idx_cstr, UINT32_MAX, 0, &success); if (!success) { - result.AppendErrorWithFormat ("invalid frame index argument '%s'", frame_idx_cstr); + result.AppendErrorWithFormat("invalid frame index argument '%s'.", frame_idx_cstr); result.SetStatus (eReturnStatusFailed); return false; } @@ -292,25 +285,19 @@ CommandObjectFrameSelect::CommandOptions::g_option_table[] = class CommandObjectFrameVariable : public CommandObjectParsed { public: - CommandObjectFrameVariable (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "frame variable", - "Show frame variables. All argument and local variables " - "that are in scope will be shown when no arguments are given. " - "If any arguments are specified, they can be names of " - "argument, local, file static and file global variables. " - "Children of aggregate variables can be specified such as " - "'var->child.x'.", - nullptr, - eCommandRequiresFrame | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused | - eCommandRequiresProcess), - m_option_group (interpreter), - m_option_variable(true), // Include the frame specific options by passing "true" - m_option_format (eFormatDefault), - m_varobj_options() + CommandObjectFrameVariable(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "frame variable", "Show variables for the current stack frame. Defaults to all " + "arguments and local variables in scope. Names of argument, " + "local, file static and file global variables can be specified. " + "Children of aggregate variables can be specified such as " + "'var->child.x'.", + nullptr, eCommandRequiresFrame | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched | + eCommandProcessMustBePaused | eCommandRequiresProcess), + m_option_group(interpreter), + m_option_variable(true), // Include the frame specific options by passing "true" + m_option_format(eFormatDefault), + m_varobj_options() { CommandArgumentEntry arg; CommandArgumentData var_name_arg; @@ -495,7 +482,9 @@ protected: if (error_cstr) result.GetErrorStream().Printf("error: %s\n", error_cstr); else - result.GetErrorStream().Printf ("error: unable to find any variable expression path that matches '%s'\n", name_cstr); + result.GetErrorStream().Printf( + "error: unable to find any variable expression path that matches '%s'.\n", + name_cstr); } } } @@ -612,11 +601,10 @@ protected: // CommandObjectMultiwordFrame //------------------------------------------------------------------------- -CommandObjectMultiwordFrame::CommandObjectMultiwordFrame (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "frame", - "A set of commands for operating on the current thread's frames.", - "frame <subcommand> [<subcommand-options>]") +CommandObjectMultiwordFrame::CommandObjectMultiwordFrame(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "frame", + "Commands for selecting and examing the current thread's stack frames.", + "frame <subcommand> [<subcommand-options>]") { LoadSubCommand ("info", CommandObjectSP (new CommandObjectFrameInfo (interpreter))); LoadSubCommand ("select", CommandObjectSP (new CommandObjectFrameSelect (interpreter))); diff --git a/lldb/source/Commands/CommandObjectHelp.cpp b/lldb/source/Commands/CommandObjectHelp.cpp index 1e9d0b6..4cf7488 100644 --- a/lldb/source/Commands/CommandObjectHelp.cpp +++ b/lldb/source/Commands/CommandObjectHelp.cpp @@ -49,11 +49,11 @@ CommandObjectHelp::GenerateAdditionalHelpAvenuesMessage (Stream *s, } } -CommandObjectHelp::CommandObjectHelp (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "help", - "Show a list of all debugger commands, or give details about specific commands.", - "help [<cmd-name>]"), m_options (interpreter) +CommandObjectHelp::CommandObjectHelp(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "help", + "Show a list of all debugger commands, or give details about a specific command.", + "help [<cmd-name>]"), + m_options(interpreter) { CommandArgumentEntry arg; CommandArgumentData command_arg; diff --git a/lldb/source/Commands/CommandObjectLanguage.cpp b/lldb/source/Commands/CommandObjectLanguage.cpp index 5a8f166..ebe3376 100644 --- a/lldb/source/Commands/CommandObjectLanguage.cpp +++ b/lldb/source/Commands/CommandObjectLanguage.cpp @@ -20,22 +20,14 @@ using namespace lldb; using namespace lldb_private; -CommandObjectLanguage::CommandObjectLanguage (CommandInterpreter &interpreter) : -CommandObjectMultiword (interpreter, - "language", - "A set of commands for managing language-specific functionality.'.", - "language <language-name> <subcommand> [<subcommand-options>]" - ) +CommandObjectLanguage::CommandObjectLanguage(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "language", "Commands specific to a source language.", + "language <language-name> <subcommand> [<subcommand-options>]") { //Let the LanguageRuntime populates this command with subcommands LanguageRuntime::InitializeCommands(this); } -void -CommandObjectLanguage::GenerateHelpText (Stream &output_stream) { - CommandObjectMultiword::GenerateHelpText(output_stream); -} - CommandObjectLanguage::~CommandObjectLanguage () { } diff --git a/lldb/source/Commands/CommandObjectLanguage.h b/lldb/source/Commands/CommandObjectLanguage.h index 15902bb8..6003a59 100644 --- a/lldb/source/Commands/CommandObjectLanguage.h +++ b/lldb/source/Commands/CommandObjectLanguage.h @@ -27,9 +27,6 @@ namespace lldb_private { ~CommandObjectLanguage() override; - void - GenerateHelpText(Stream &output_stream) override; - protected: bool DoExecute (Args& command, CommandReturnObject &result); diff --git a/lldb/source/Commands/CommandObjectLog.cpp b/lldb/source/Commands/CommandObjectLog.cpp index 05ecb59..ca6b39c 100644 --- a/lldb/source/Commands/CommandObjectLog.cpp +++ b/lldb/source/Commands/CommandObjectLog.cpp @@ -451,11 +451,9 @@ protected: } }; -CommandObjectLog::CommandObjectLog(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "log", - "A set of commands for operating on logs.", - "log <command> [<command-options>]") +CommandObjectLog::CommandObjectLog(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "log", "Commands controlling LLDB internal logging.", + "log <subcommand> [<command-options>]") { LoadSubCommand ("enable", CommandObjectSP (new CommandObjectLogEnable (interpreter))); LoadSubCommand ("disable", CommandObjectSP (new CommandObjectLogDisable (interpreter))); diff --git a/lldb/source/Commands/CommandObjectMemory.cpp b/lldb/source/Commands/CommandObjectMemory.cpp index 1ae8741..7065e65 100644 --- a/lldb/source/Commands/CommandObjectMemory.cpp +++ b/lldb/source/Commands/CommandObjectMemory.cpp @@ -205,9 +205,11 @@ public: if (byte_size_option_set) { if (byte_size_value > 1) - error.SetErrorStringWithFormat ("display format (bytes/bytes with ascii) conflicts with the specified byte size %" PRIu64 "\n" - "\tconsider using a different display format or don't specify the byte size", - byte_size_value.GetCurrentValue()); + error.SetErrorStringWithFormat( + "display format (bytes/bytes with ASCII) conflicts with the specified byte size %" PRIu64 + "\n" + "\tconsider using a different display format or don't specify the byte size.", + byte_size_value.GetCurrentValue()); } else byte_size_value = 1; @@ -318,23 +320,20 @@ public: class CommandObjectMemoryRead : public CommandObjectParsed { public: - CommandObjectMemoryRead (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "memory read", - "Read from the memory of the process being debugged.", - nullptr, - eCommandRequiresTarget | eCommandProcessMustBePaused), - m_option_group (interpreter), - m_format_options (eFormatBytesWithASCII, 1, 8), - m_memory_options (), - m_outfile_options (), - m_varobj_options(), - m_next_addr(LLDB_INVALID_ADDRESS), - m_prev_byte_size(0), - m_prev_format_options (eFormatBytesWithASCII, 1, 8), - m_prev_memory_options (), - m_prev_outfile_options (), - m_prev_varobj_options() + CommandObjectMemoryRead(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "memory read", "Read from the memory of the current target process.", + nullptr, eCommandRequiresTarget | eCommandProcessMustBePaused), + m_option_group(interpreter), + m_format_options(eFormatBytesWithASCII, 1, 8), + m_memory_options(), + m_outfile_options(), + m_varobj_options(), + m_next_addr(LLDB_INVALID_ADDRESS), + m_prev_byte_size(0), + m_prev_format_options(eFormatBytesWithASCII, 1, 8), + m_prev_memory_options(), + m_prev_outfile_options(), + m_prev_varobj_options() { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -1041,15 +1040,12 @@ public: OptionValueUInt64 m_count; OptionValueUInt64 m_offset; }; - - CommandObjectMemoryFind (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "memory find", - "Find a value in the memory of the process being debugged.", - nullptr, - eCommandRequiresProcess | eCommandProcessMustBeLaunched), - m_option_group (interpreter), - m_memory_options () + + CommandObjectMemoryFind(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "memory find", "Find a value in the memory of the current target process.", + nullptr, eCommandRequiresProcess | eCommandProcessMustBeLaunched), + m_option_group(interpreter), + m_memory_options() { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -1325,15 +1321,12 @@ public: off_t m_infile_offset; }; - CommandObjectMemoryWrite (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "memory write", - "Write to the memory of the process being debugged.", - nullptr, - eCommandRequiresProcess | eCommandProcessMustBeLaunched), - m_option_group (interpreter), - m_format_options (eFormatBytes, 1, UINT64_MAX), - m_memory_options () + CommandObjectMemoryWrite(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "memory write", "Write to the memory of the current target process.", + nullptr, eCommandRequiresProcess | eCommandProcessMustBeLaunched), + m_option_group(interpreter), + m_format_options(eFormatBytes, 1, UINT64_MAX), + m_memory_options() { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -1687,13 +1680,12 @@ protected: class CommandObjectMemoryHistory : public CommandObjectParsed { public: - CommandObjectMemoryHistory (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "memory history", - "Prints out the recorded stack traces for allocation/deallocation of a memory address.", - nullptr, - eCommandRequiresTarget | eCommandRequiresProcess | eCommandProcessMustBePaused | - eCommandProcessMustBeLaunched) + CommandObjectMemoryHistory(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "memory history", + "Print recorded stack traces for allocation/deallocation events associated with an address.", nullptr, + eCommandRequiresTarget | eCommandRequiresProcess | eCommandProcessMustBePaused | + eCommandProcessMustBeLaunched) { CommandArgumentEntry arg1; CommandArgumentData addr_arg; @@ -1777,10 +1769,10 @@ class CommandObjectMemoryRegion : public CommandObjectParsed { public: CommandObjectMemoryRegion(CommandInterpreter &interpreter) - : CommandObjectParsed(interpreter, "memory region", - "Get information on a memory region that contains an address in the current process.", - "memory region ADDR", - eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched), + : CommandObjectParsed( + interpreter, "memory region", + "Get information on the memory region containing an address in the current target process.", + "memory region ADDR", eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched), m_prev_end_addr(LLDB_INVALID_ADDRESS) { } @@ -1875,11 +1867,9 @@ protected: // CommandObjectMemory //------------------------------------------------------------------------- -CommandObjectMemory::CommandObjectMemory (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "memory", - "A set of commands for operating on memory.", - "memory <subcommand> [<subcommand-options>]") +CommandObjectMemory::CommandObjectMemory(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "memory", "Commands for operating on memory in the current target process.", + "memory <subcommand> [<subcommand-options>]") { LoadSubCommand("find", CommandObjectSP(new CommandObjectMemoryFind(interpreter))); LoadSubCommand("read", CommandObjectSP(new CommandObjectMemoryRead(interpreter))); diff --git a/lldb/source/Commands/CommandObjectMultiword.cpp b/lldb/source/Commands/CommandObjectMultiword.cpp index ae19976..c951e0b 100644 --- a/lldb/source/Commands/CommandObjectMultiword.cpp +++ b/lldb/source/Commands/CommandObjectMultiword.cpp @@ -178,7 +178,8 @@ CommandObjectMultiword::GenerateHelpText (Stream &output_stream) // First time through here, generate the help text for the object and // push it to the return result object as well - output_stream.PutCString ("The following subcommands are supported:\n\n"); + CommandObject::GenerateHelpText(output_stream); + output_stream.PutCString("\nThe following subcommands are supported:\n\n"); CommandMap::iterator pos; uint32_t max_len = FindLongestCommandWord (m_subcommand_dict); @@ -193,7 +194,7 @@ CommandObjectMultiword::GenerateHelpText (Stream &output_stream) if (pos->second->WantsRawCommandString ()) { std::string help_text (pos->second->GetHelp()); - help_text.append (" This command takes 'raw' input (no need to quote stuff)."); + help_text.append(" Expects 'raw' input (see 'help raw-input'.)"); m_interpreter.OutputFormattedHelpText (output_stream, indented_command.c_str(), "--", diff --git a/lldb/source/Commands/CommandObjectPlatform.cpp b/lldb/source/Commands/CommandObjectPlatform.cpp index ef9726b..99bd63b 100644 --- a/lldb/source/Commands/CommandObjectPlatform.cpp +++ b/lldb/source/Commands/CommandObjectPlatform.cpp @@ -329,12 +329,8 @@ protected: class CommandObjectPlatformStatus : public CommandObjectParsed { public: - CommandObjectPlatformStatus (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "platform status", - "Display status for the currently selected platform.", - nullptr, - 0) + CommandObjectPlatformStatus(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "platform status", "Display status for the current platform.", nullptr, 0) { } @@ -376,12 +372,10 @@ protected: class CommandObjectPlatformConnect : public CommandObjectParsed { public: - CommandObjectPlatformConnect (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "platform connect", - "Connect a platform by name to be the currently selected platform.", - "platform connect <connect-url>", - 0) + CommandObjectPlatformConnect(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "platform connect", + "Select the current platform by providing a connection URL.", + "platform connect <connect-url>", 0) { } @@ -444,12 +438,9 @@ protected: class CommandObjectPlatformDisconnect : public CommandObjectParsed { public: - CommandObjectPlatformDisconnect (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "platform disconnect", - "Disconnect a platform by name to be the currently selected platform.", - "platform disconnect", - 0) + CommandObjectPlatformDisconnect(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "platform disconnect", "Disconnect from the current platform.", + "platform disconnect", 0) { } @@ -995,11 +986,9 @@ public: //------------------------------------------------------------------ // Constructors and Destructors //------------------------------------------------------------------ - CommandObjectPlatformFile (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "platform file", - "A set of commands to manage file access through a platform", - "platform file [open|close|read|write] ...") + CommandObjectPlatformFile(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "platform file", "Commands to access files on the current platform.", + "platform file [open|close|read|write] ...") { LoadSubCommand ("open", CommandObjectSP (new CommandObjectPlatformFOpen (interpreter))); LoadSubCommand ("close", CommandObjectSP (new CommandObjectPlatformFClose (interpreter))); @@ -1930,11 +1919,10 @@ public: //------------------------------------------------------------------ // Constructors and Destructors //------------------------------------------------------------------ - CommandObjectPlatformProcess (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "platform process", - "A set of commands to query, launch and attach to platform processes", - "platform process [attach|launch|list] ...") + CommandObjectPlatformProcess(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "platform process", + "Commands to query, launch and attach to processes on the current platform.", + "platform process [attach|launch|list] ...") { LoadSubCommand ("attach", CommandObjectSP (new CommandObjectPlatformProcessAttach (interpreter))); LoadSubCommand ("launch", CommandObjectSP (new CommandObjectPlatformProcessLaunch (interpreter))); @@ -2016,14 +2004,11 @@ public: static OptionDefinition g_option_table[]; uint32_t timeout; }; - - CommandObjectPlatformShell (CommandInterpreter &interpreter) : - CommandObjectRaw (interpreter, - "platform shell", - "Run a shell command on the selected platform.", - "platform shell <shell-command>", - 0), - m_options(interpreter) + + CommandObjectPlatformShell(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "platform shell", "Run a shell command on the current platform.", + "platform shell <shell-command>", 0), + m_options(interpreter) { } @@ -2192,11 +2177,9 @@ public: } }; -CommandObjectPlatform::CommandObjectPlatform(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "platform", - "A set of commands to manage and create platforms.", - "platform [connect|disconnect|info|list|status|select] ...") +CommandObjectPlatform::CommandObjectPlatform(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "platform", "Commands to manage and create platforms.", + "platform [connect|disconnect|info|list|status|select] ...") { LoadSubCommand ("select", CommandObjectSP (new CommandObjectPlatformSelect (interpreter))); LoadSubCommand ("list" , CommandObjectSP (new CommandObjectPlatformList (interpreter))); diff --git a/lldb/source/Commands/CommandObjectPlugin.cpp b/lldb/source/Commands/CommandObjectPlugin.cpp index 3fae35a..221c9a6 100644 --- a/lldb/source/Commands/CommandObjectPlugin.cpp +++ b/lldb/source/Commands/CommandObjectPlugin.cpp @@ -99,11 +99,9 @@ protected: } }; -CommandObjectPlugin::CommandObjectPlugin (CommandInterpreter &interpreter) : -CommandObjectMultiword (interpreter, - "plugin", - "A set of commands for managing or customizing plugin commands.", - "plugin <subcommand> [<subcommand-options>]") +CommandObjectPlugin::CommandObjectPlugin(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "plugin", "Commands for managing LLDB plugins.", + "plugin <subcommand> [<subcommand-options>]") { LoadSubCommand ("load", CommandObjectSP (new CommandObjectPluginLoad (interpreter))); } diff --git a/lldb/source/Commands/CommandObjectProcess.cpp b/lldb/source/Commands/CommandObjectProcess.cpp index 2d1b0da..106e2d8 100644 --- a/lldb/source/Commands/CommandObjectProcess.cpp +++ b/lldb/source/Commands/CommandObjectProcess.cpp @@ -875,15 +875,11 @@ public: LazyBool m_keep_stopped; }; - CommandObjectProcessDetach (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "process detach", - "Detach from the current process being debugged.", - "process detach", - eCommandRequiresProcess | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched), - m_options(interpreter) + CommandObjectProcessDetach(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "process detach", "Detach from the current target process.", + "process detach", + eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched), + m_options(interpreter) { } @@ -1075,12 +1071,9 @@ CommandObjectProcessConnect::CommandOptions::g_option_table[] = class CommandObjectProcessPlugin : public CommandObjectProxy { public: - CommandObjectProcessPlugin (CommandInterpreter &interpreter) : - CommandObjectProxy (interpreter, - "process plugin", - "Send a custom command to the current process plug-in.", - "process plugin <args>", - 0) + CommandObjectProcessPlugin(CommandInterpreter &interpreter) + : CommandObjectProxy(interpreter, "process plugin", + "Send a custom command to the current target process plug-in.", "process plugin <args>", 0) { } @@ -1302,12 +1295,9 @@ protected: class CommandObjectProcessSignal : public CommandObjectParsed { public: - CommandObjectProcessSignal (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "process signal", - "Send a UNIX signal to the current process being debugged.", - nullptr, - eCommandRequiresProcess | eCommandTryTargetAPILock) + CommandObjectProcessSignal(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "process signal", "Send a UNIX signal to the current target process.", + nullptr, eCommandRequiresProcess | eCommandTryTargetAPILock) { CommandArgumentEntry arg; CommandArgumentData signal_arg; @@ -1378,14 +1368,10 @@ protected: class CommandObjectProcessInterrupt : public CommandObjectParsed { public: - CommandObjectProcessInterrupt (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "process interrupt", - "Interrupt the current process being debugged.", - "process interrupt", - eCommandRequiresProcess | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched) + CommandObjectProcessInterrupt(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "process interrupt", "Interrupt the current target process.", + "process interrupt", + eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched) { } @@ -1436,14 +1422,9 @@ protected: class CommandObjectProcessKill : public CommandObjectParsed { public: - CommandObjectProcessKill (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "process kill", - "Terminate the current process being debugged.", - "process kill", - eCommandRequiresProcess | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched) + CommandObjectProcessKill(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "process kill", "Terminate the current target process.", "process kill", + eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched) { } @@ -1555,12 +1536,10 @@ protected: class CommandObjectProcessStatus : public CommandObjectParsed { public: - CommandObjectProcessStatus (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, - "process status", - "Show the current status and location of executing process.", - "process status", - eCommandRequiresProcess | eCommandTryTargetAPILock) + CommandObjectProcessStatus(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "process status", + "Show status and stop location for the current target process.", "process status", + eCommandRequiresProcess | eCommandTryTargetAPILock) { } @@ -1655,12 +1634,12 @@ public: std::string pass; }; - CommandObjectProcessHandle (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "process handle", - "Show or update what the process and debugger should do with various signals received from the OS.", - nullptr), - m_options (interpreter) + CommandObjectProcessHandle(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "process handle", + "Manage LLDB handling of OS signals for the current target process. Defaults to showing current policy.", + nullptr), + m_options(interpreter) { SetHelpLong ("\nIf no signals are specified, update them all. If no update " "option is specified, list the current values."); @@ -1889,11 +1868,9 @@ CommandObjectProcessHandle::CommandOptions::g_option_table[] = // CommandObjectMultiwordProcess //------------------------------------------------------------------------- -CommandObjectMultiwordProcess::CommandObjectMultiwordProcess (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "process", - "A set of commands for operating on a process.", - "process <subcommand> [<subcommand-options>]") +CommandObjectMultiwordProcess::CommandObjectMultiwordProcess(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "process", "Commands for interacting with processes on the current platform.", + "process <subcommand> [<subcommand-options>]") { LoadSubCommand ("attach", CommandObjectSP (new CommandObjectProcessAttach (interpreter))); LoadSubCommand ("launch", CommandObjectSP (new CommandObjectProcessLaunch (interpreter))); diff --git a/lldb/source/Commands/CommandObjectQuit.cpp b/lldb/source/Commands/CommandObjectQuit.cpp index 31f82b9..a650398 100644 --- a/lldb/source/Commands/CommandObjectQuit.cpp +++ b/lldb/source/Commands/CommandObjectQuit.cpp @@ -24,8 +24,8 @@ using namespace lldb_private; // CommandObjectQuit //------------------------------------------------------------------------- -CommandObjectQuit::CommandObjectQuit (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, "quit", "Quit out of the LLDB debugger.", "quit") +CommandObjectQuit::CommandObjectQuit(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "quit", "Quit the LLDB debugger.", "quit") { } diff --git a/lldb/source/Commands/CommandObjectRegister.cpp b/lldb/source/Commands/CommandObjectRegister.cpp index f2191a5..ff8df2a 100644 --- a/lldb/source/Commands/CommandObjectRegister.cpp +++ b/lldb/source/Commands/CommandObjectRegister.cpp @@ -467,11 +467,10 @@ protected: //---------------------------------------------------------------------- // CommandObjectRegister constructor //---------------------------------------------------------------------- -CommandObjectRegister::CommandObjectRegister(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "register", - "A set of commands to access thread registers.", - "register [read|write] ...") +CommandObjectRegister::CommandObjectRegister(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "register", + "Commands to access registers for the current thread and stack frame.", + "register [read|write] ...") { LoadSubCommand ("read", CommandObjectSP (new CommandObjectRegisterRead (interpreter))); LoadSubCommand ("write", CommandObjectSP (new CommandObjectRegisterWrite (interpreter))); diff --git a/lldb/source/Commands/CommandObjectSettings.cpp b/lldb/source/Commands/CommandObjectSettings.cpp index b2c4743..b76af20 100644 --- a/lldb/source/Commands/CommandObjectSettings.cpp +++ b/lldb/source/Commands/CommandObjectSettings.cpp @@ -30,12 +30,9 @@ using namespace lldb_private; class CommandObjectSettingsSet : public CommandObjectRaw { public: - CommandObjectSettingsSet (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "settings set", - "Set or change the value of a single debugger setting variable.", - nullptr), - m_options (interpreter) + CommandObjectSettingsSet(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "settings set", "Set the value of the specified debugger setting.", nullptr), + m_options(interpreter) { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -298,11 +295,10 @@ CommandObjectSettingsSet::CommandOptions::g_option_table[] = class CommandObjectSettingsShow : public CommandObjectParsed { public: - CommandObjectSettingsShow (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "settings show", - "Show the specified internal debugger setting variable and its value, or show all the currently set variables and their values, if nothing is specified.", - nullptr) + CommandObjectSettingsShow(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "settings show", + "Show matching debugger settings and their current values. Defaults to showing all settings.", nullptr) { CommandArgumentEntry arg1; CommandArgumentData var_name_arg; @@ -383,12 +379,11 @@ protected: class CommandObjectSettingsList : public CommandObjectParsed { -public: - CommandObjectSettingsList (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "settings list", - "List and describe all the internal debugger settings variables that are available to the user to 'set' or 'show', or describe a particular variable or set of variables (by specifying the variable name or a common prefix).", - nullptr) +public: + CommandObjectSettingsList(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "settings list", + "List and describe matching debugger settings. Defaults to all listing all settings.", + nullptr) { CommandArgumentEntry arg; CommandArgumentData var_name_arg; @@ -479,11 +474,9 @@ protected: class CommandObjectSettingsRemove : public CommandObjectRaw { public: - CommandObjectSettingsRemove (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "settings remove", - "Remove the specified element from an array or dictionary settings variable.", - nullptr) + CommandObjectSettingsRemove(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "settings remove", + "Remove a value from a setting, specified by array index or dictionary key.", nullptr) { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -598,11 +591,9 @@ protected: class CommandObjectSettingsReplace : public CommandObjectRaw { public: - CommandObjectSettingsReplace (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "settings replace", - "Replace the specified element from an internal debugger settings array or dictionary variable with the specified new value.", - nullptr) + CommandObjectSettingsReplace(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "settings replace", + "Replace the debugger setting value specified by array index or dictionary key.", nullptr) { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -723,11 +714,11 @@ protected: class CommandObjectSettingsInsertBefore : public CommandObjectRaw { public: - CommandObjectSettingsInsertBefore (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "settings insert-before", - "Insert value(s) into an internal debugger settings array variable, immediately before the specified element.", - nullptr) + CommandObjectSettingsInsertBefore(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "settings insert-before", "Insert one or more values into an debugger array " + "setting immediately before the specified element " + "index.", + nullptr) { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -846,11 +837,10 @@ protected: class CommandObjectSettingsInsertAfter : public CommandObjectRaw { public: - CommandObjectSettingsInsertAfter (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "settings insert-after", - "Insert value(s) into an internal debugger settings array variable, immediately after the specified element.", - nullptr) + CommandObjectSettingsInsertAfter(CommandInterpreter &interpreter) + : CommandObjectRaw( + interpreter, "settings insert-after", + "Insert one or more values into a debugger array settings after the specified element index.", nullptr) { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -969,11 +959,9 @@ protected: class CommandObjectSettingsAppend : public CommandObjectRaw { public: - CommandObjectSettingsAppend (CommandInterpreter &interpreter) : - CommandObjectRaw(interpreter, - "settings append", - "Append a new value to the end of an internal debugger settings array, dictionary or string variable.", - nullptr) + CommandObjectSettingsAppend(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "settings append", + "Append one or more values to a debugger array, dictionary, or string setting.", nullptr) { CommandArgumentEntry arg1; CommandArgumentEntry arg2; @@ -1084,11 +1072,9 @@ protected: class CommandObjectSettingsClear : public CommandObjectParsed { public: - CommandObjectSettingsClear (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "settings clear", - "Erase all the contents of an internal debugger settings variables; this is only valid for variables with clearable types, i.e. strings, arrays or dictionaries.", - nullptr) + CommandObjectSettingsClear(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "settings clear", "Clear a debugger setting array, dictionary, or string.", + nullptr) { CommandArgumentEntry arg; CommandArgumentData var_name_arg; @@ -1173,11 +1159,9 @@ protected: // CommandObjectMultiwordSettings //------------------------------------------------------------------------- -CommandObjectMultiwordSettings::CommandObjectMultiwordSettings (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "settings", - "A set of commands for manipulating internal settable debugger variables.", - "settings <command> [<command-options>]") +CommandObjectMultiwordSettings::CommandObjectMultiwordSettings(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "settings", "Commands for managing LLDB settings.", + "settings <subcommand> [<command-options>]") { LoadSubCommand ("set", CommandObjectSP (new CommandObjectSettingsSet (interpreter))); LoadSubCommand ("show", CommandObjectSP (new CommandObjectSettingsShow (interpreter))); diff --git a/lldb/source/Commands/CommandObjectSource.cpp b/lldb/source/Commands/CommandObjectSource.cpp index 3541f9b..cef9d09 100644 --- a/lldb/source/Commands/CommandObjectSource.cpp +++ b/lldb/source/Commands/CommandObjectSource.cpp @@ -132,14 +132,12 @@ class CommandObjectSourceInfo : public CommandObjectParsed }; public: - CommandObjectSourceInfo (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "source info", - "Display source line information (as specified) based " - "on the current executable's debug info.", - nullptr, - eCommandRequiresTarget), - m_options(interpreter) + CommandObjectSourceInfo(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "source info", "Display source line information for the current target " + "process. Defaults to instruction pointer in current stack " + "frame.", + nullptr, eCommandRequiresTarget), + m_options(interpreter) { } @@ -821,15 +819,13 @@ class CommandObjectSourceList : public CommandObjectParsed bool show_bp_locs; bool reverse; }; - -public: - CommandObjectSourceList(CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "source list", - "Display source code (as specified) based on the current executable's debug info.", - nullptr, - eCommandRequiresTarget), - m_options (interpreter) + +public: + CommandObjectSourceList(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "source list", + "Display source code for the current target process as specified by options.", nullptr, + eCommandRequiresTarget), + m_options(interpreter) { } @@ -1482,11 +1478,11 @@ CommandObjectSourceList::CommandOptions::g_option_table[] = // CommandObjectMultiwordSource //------------------------------------------------------------------------- -CommandObjectMultiwordSource::CommandObjectMultiwordSource (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "source", - "A set of commands for accessing source file information", - "source <subcommand> [<subcommand-options>]") +CommandObjectMultiwordSource::CommandObjectMultiwordSource(CommandInterpreter &interpreter) + : CommandObjectMultiword( + interpreter, "source", + "Commands for examining source code described by debug information for the current target process.", + "source <subcommand> [<subcommand-options>]") { LoadSubCommand ("info", CommandObjectSP (new CommandObjectSourceInfo (interpreter))); LoadSubCommand ("list", CommandObjectSP (new CommandObjectSourceList (interpreter))); diff --git a/lldb/source/Commands/CommandObjectTarget.cpp b/lldb/source/Commands/CommandObjectTarget.cpp index f70100c..9e535ba 100644 --- a/lldb/source/Commands/CommandObjectTarget.cpp +++ b/lldb/source/Commands/CommandObjectTarget.cpp @@ -724,22 +724,20 @@ class CommandObjectTargetVariable : public CommandObjectParsed static const uint32_t SHORT_OPTION_SHLB = 0x73686c62; // 'shlb' public: - CommandObjectTargetVariable (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "target variable", - "Read global variable(s) prior to, or while running your binary.", - nullptr, - eCommandRequiresTarget), - m_option_group (interpreter), - m_option_variable (false), // Don't include frame options - m_option_format (eFormatDefault), - m_option_compile_units (LLDB_OPT_SET_1, false, "file", - SHORT_OPTION_FILE, 0, eArgTypeFilename, - "A basename or fullpath to a file that contains global variables. This option can be specified multiple times."), - m_option_shared_libraries (LLDB_OPT_SET_1, false, "shlib", - SHORT_OPTION_SHLB, 0, eArgTypeFilename, - "A basename or fullpath to a shared library to use in the search for global variables. This option can be specified multiple times."), - m_varobj_options() + CommandObjectTargetVariable(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "target variable", + "Read global variables for the current target, before or while running a process.", + nullptr, eCommandRequiresTarget), + m_option_group(interpreter), + m_option_variable(false), // Don't include frame options + m_option_format(eFormatDefault), + m_option_compile_units(LLDB_OPT_SET_1, false, "file", SHORT_OPTION_FILE, 0, eArgTypeFilename, + "A basename or fullpath to a file that contains global variables. This option can be " + "specified multiple times."), + m_option_shared_libraries(LLDB_OPT_SET_1, false, "shlib", SHORT_OPTION_SHLB, 0, eArgTypeFilename, + "A basename or fullpath to a shared library to use in the search for global " + "variables. This option can be specified multiple times."), + m_varobj_options() { CommandArgumentEntry arg; CommandArgumentData var_name_arg; @@ -2685,8 +2683,7 @@ public: //------------------------------------------------------------------ CommandObjectTargetModulesDump(CommandInterpreter &interpreter) : CommandObjectMultiword( - interpreter, "target modules dump", - "A set of commands for dumping information about one or more target modules.", + interpreter, "target modules dump", "Commands for dumping information about one or more target modules.", "target modules dump [headers|symtab|sections|symfile|line-table] [<file1> <file2> ...]") { LoadSubCommand("objfile", CommandObjectSP(new CommandObjectTargetModulesDumpObjfile(interpreter))); @@ -4336,11 +4333,10 @@ CommandObjectTargetModulesLookup::CommandOptions::g_option_table[] = class CommandObjectTargetModulesImageSearchPaths : public CommandObjectMultiword { public: - CommandObjectTargetModulesImageSearchPaths (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "target modules search-paths", - "A set of commands for operating on debugger target image search paths.", - "target modules search-paths <subcommand> [<subcommand-options>]") + CommandObjectTargetModulesImageSearchPaths(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "target modules search-paths", + "Commands for managing module search paths for a target.", + "target modules search-paths <subcommand> [<subcommand-options>]") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetModulesSearchPathsAdd (interpreter))); LoadSubCommand ("clear", CommandObjectSP (new CommandObjectTargetModulesSearchPathsClear (interpreter))); @@ -4364,11 +4360,10 @@ public: //------------------------------------------------------------------ // Constructors and Destructors //------------------------------------------------------------------ - CommandObjectTargetModules(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "target modules", - "A set of commands for accessing information for one or more target modules.", - "target modules <sub-command> ...") + CommandObjectTargetModules(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "target modules", + "Commands for accessing information for one or more target modules.", + "target modules <sub-command> ...") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetModulesAdd (interpreter))); LoadSubCommand ("load", CommandObjectSP (new CommandObjectTargetModulesLoad (interpreter))); @@ -4822,11 +4817,9 @@ public: //------------------------------------------------------------------ // Constructors and Destructors //------------------------------------------------------------------ - CommandObjectTargetSymbols(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "target symbols", - "A set of commands for adding and managing debug symbol files.", - "target symbols <sub-command> ...") + CommandObjectTargetSymbols(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "target symbols", "Commands for adding and managing debug symbol files.", + "target symbols <sub-command> ...") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetSymbolsAdd (interpreter))); } @@ -5403,11 +5396,10 @@ protected: class CommandObjectMultiwordTargetStopHooks : public CommandObjectMultiword { public: - CommandObjectMultiwordTargetStopHooks (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "target stop-hook", - "A set of commands for operating on debugger target stop-hooks.", - "target stop-hook <subcommand> [<subcommand-options>]") + CommandObjectMultiwordTargetStopHooks(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "target stop-hook", + "Commands for operating on debugger target stop-hooks.", + "target stop-hook <subcommand> [<subcommand-options>]") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetStopHookAdd (interpreter))); LoadSubCommand ("delete", CommandObjectSP (new CommandObjectTargetStopHookDelete (interpreter))); @@ -5433,11 +5425,9 @@ public: // CommandObjectMultiwordTarget //------------------------------------------------------------------------- -CommandObjectMultiwordTarget::CommandObjectMultiwordTarget (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "target", - "A set of commands for operating on debugger targets.", - "target <subcommand> [<subcommand-options>]") +CommandObjectMultiwordTarget::CommandObjectMultiwordTarget(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "target", "Commands for operating on debugger targets.", + "target <subcommand> [<subcommand-options>]") { LoadSubCommand ("create", CommandObjectSP (new CommandObjectTargetCreate (interpreter))); LoadSubCommand ("delete", CommandObjectSP (new CommandObjectTargetDelete (interpreter))); diff --git a/lldb/source/Commands/CommandObjectThread.cpp b/lldb/source/Commands/CommandObjectThread.cpp index 864300c..9e4bffd 100644 --- a/lldb/source/Commands/CommandObjectThread.cpp +++ b/lldb/source/Commands/CommandObjectThread.cpp @@ -229,17 +229,14 @@ public: bool m_extended_backtrace; }; - CommandObjectThreadBacktrace (CommandInterpreter &interpreter) : - CommandObjectIterateOverThreads(interpreter, - "thread backtrace", - "Show the stack for one or more threads. If no threads are specified, show the currently selected thread. Use the thread-index \"all\" to see all threads.", - nullptr, - eCommandRequiresProcess | - eCommandRequiresThread | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ), - m_options(interpreter) + CommandObjectThreadBacktrace(CommandInterpreter &interpreter) + : CommandObjectIterateOverThreads( + interpreter, "thread backtrace", "Show thread call stacks. Defaults to the current thread, thread " + "indexes can be specified as arguments. Use the thread-index \"all\" " + "to see all threads.", + nullptr, eCommandRequiresProcess | eCommandRequiresThread | eCommandTryTargetAPILock | + eCommandProcessMustBeLaunched | eCommandProcessMustBePaused), + m_options(interpreter) { } @@ -804,15 +801,12 @@ CommandObjectThreadStepWithTypeAndScope::CommandOptions::g_option_table[] = class CommandObjectThreadContinue : public CommandObjectParsed { public: - CommandObjectThreadContinue (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "thread continue", - "Continue execution of one or more threads in an active process.", - nullptr, - eCommandRequiresThread | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused) + CommandObjectThreadContinue(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "thread continue", "Continue execution of the current target process. One " + "or more threads may be specified, by default all " + "threads continue.", + nullptr, eCommandRequiresThread | eCommandTryTargetAPILock | + eCommandProcessMustBeLaunched | eCommandProcessMustBePaused) { CommandArgumentEntry arg; CommandArgumentData thread_idx_arg; @@ -1101,16 +1095,13 @@ public: // Instance variables to hold the values for command options. }; - CommandObjectThreadUntil (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "thread until", - "Run the current or specified thread until it reaches a given line number or address or leaves the current function.", - nullptr, - eCommandRequiresThread | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ), - m_options (interpreter) + CommandObjectThreadUntil(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "thread until", "Continue until a line number or address is reached by the " + "current or specified thread. Stops when returning from " + "the current function as a safety measure.", + nullptr, eCommandRequiresThread | eCommandTryTargetAPILock | + eCommandProcessMustBeLaunched | eCommandProcessMustBePaused), + m_options(interpreter) { CommandArgumentEntry arg; CommandArgumentData line_num_arg; @@ -1366,15 +1357,10 @@ CommandObjectThreadUntil::CommandOptions::g_option_table[] = class CommandObjectThreadSelect : public CommandObjectParsed { public: - CommandObjectThreadSelect (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "thread select", - "Select a thread as the currently active thread.", - nullptr, - eCommandRequiresProcess | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ) + CommandObjectThreadSelect(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "thread select", "Change the currently selected thread.", nullptr, + eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched | + eCommandProcessMustBePaused) { CommandArgumentEntry arg; CommandArgumentData thread_idx_arg; @@ -1434,15 +1420,11 @@ protected: class CommandObjectThreadList : public CommandObjectParsed { public: - CommandObjectThreadList (CommandInterpreter &interpreter): - CommandObjectParsed (interpreter, - "thread list", - "Show a summary of all current threads in a process.", - "thread list", - eCommandRequiresProcess | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ) + CommandObjectThreadList(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "thread list", + "Show a summary of each thread in the current target process.", "thread list", + eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched | + eCommandProcessMustBePaused) { } @@ -1528,16 +1510,13 @@ public: static OptionDefinition g_option_table[]; }; - CommandObjectThreadInfo (CommandInterpreter &interpreter) : - CommandObjectIterateOverThreads (interpreter, - "thread info", - "Show an extended summary of information about thread(s) in a process.", - "thread info", - eCommandRequiresProcess | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused), - m_options (interpreter) + CommandObjectThreadInfo(CommandInterpreter &interpreter) + : CommandObjectIterateOverThreads( + interpreter, "thread info", + "Show an extended summary of one or more threads. Defaults to the current thread.", "thread info", + eCommandRequiresProcess | eCommandTryTargetAPILock | eCommandProcessMustBeLaunched | + eCommandProcessMustBePaused), + m_options(interpreter) { m_add_return = false; } @@ -1653,17 +1632,14 @@ public: // Instance variables to hold the values for command options. }; - CommandObjectThreadReturn (CommandInterpreter &interpreter) : - CommandObjectRaw (interpreter, - "thread return", - "Return from the currently selected frame, short-circuiting execution of the frames below it, with an optional return value," - " or with the -x option from the innermost function evaluation.", - "thread return", - eCommandRequiresFrame | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ), - m_options (interpreter) + CommandObjectThreadReturn(CommandInterpreter &interpreter) + : CommandObjectRaw(interpreter, "thread return", + "Prematurely return from a stack frame, short-circuiting execution of newer frames " + "and optionally yielding a specified value. Defaults to the exiting the current stack " + "frame.", + "thread return", eCommandRequiresFrame | eCommandTryTargetAPILock | + eCommandProcessMustBeLaunched | eCommandProcessMustBePaused), + m_options(interpreter) { CommandArgumentEntry arg; CommandArgumentData expression_arg; @@ -2043,18 +2019,14 @@ public: bool m_internal; }; - CommandObjectThreadPlanList (CommandInterpreter &interpreter) : - CommandObjectIterateOverThreads(interpreter, - "thread plan list", - "Show thread plans for one or more threads. If no threads are specified, show the " - "currently selected thread. Use the thread-index \"all\" to see all threads.", - nullptr, - eCommandRequiresProcess | - eCommandRequiresThread | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ), - m_options(interpreter) + CommandObjectThreadPlanList(CommandInterpreter &interpreter) + : CommandObjectIterateOverThreads( + interpreter, "thread plan list", + "Show thread plans for one or more threads. If no threads are specified, show the " + "current thread. Use the thread-index \"all\" to see all threads.", + nullptr, eCommandRequiresProcess | eCommandRequiresThread | eCommandTryTargetAPILock | + eCommandProcessMustBeLaunched | eCommandProcessMustBePaused), + m_options(interpreter) { } @@ -2103,18 +2075,13 @@ CommandObjectThreadPlanList::CommandOptions::g_option_table[] = class CommandObjectThreadPlanDiscard : public CommandObjectParsed { public: - CommandObjectThreadPlanDiscard (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "thread plan discard", - "Discards thread plans up to and including the plan passed as the command argument." - "Only user visible plans can be discarded, use the index from \"thread plan list\"" - " without the \"-i\" argument.", - nullptr, - eCommandRequiresProcess | - eCommandRequiresThread | - eCommandTryTargetAPILock | - eCommandProcessMustBeLaunched | - eCommandProcessMustBePaused ) + CommandObjectThreadPlanDiscard(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "thread plan discard", + "Discards thread plans up to and including the specified index (see 'thread plan list'.) " + "Only user visible plans can be discarded.", + nullptr, eCommandRequiresProcess | eCommandRequiresThread | eCommandTryTargetAPILock | + eCommandProcessMustBeLaunched | eCommandProcessMustBePaused) { CommandArgumentEntry arg; CommandArgumentData plan_index_arg; @@ -2183,11 +2150,9 @@ public: class CommandObjectMultiwordThreadPlan : public CommandObjectMultiword { public: - CommandObjectMultiwordThreadPlan(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "plan", - "A set of subcommands for accessing the thread plans controlling execution control on one or more threads.", - "thread plan <subcommand> [<subcommand objects]") + CommandObjectMultiwordThreadPlan(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "plan", "Commands for managing thread plans that control execution.", + "thread plan <subcommand> [<subcommand objects]") { LoadSubCommand ("list", CommandObjectSP (new CommandObjectThreadPlanList (interpreter))); LoadSubCommand ("discard", CommandObjectSP (new CommandObjectThreadPlanDiscard (interpreter))); @@ -2200,11 +2165,10 @@ public: // CommandObjectMultiwordThread //------------------------------------------------------------------------- -CommandObjectMultiwordThread::CommandObjectMultiwordThread (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "thread", - "A set of commands for operating on one or more threads within a running process.", - "thread <subcommand> [<subcommand-options>]") +CommandObjectMultiwordThread::CommandObjectMultiwordThread(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "thread", + "Commands for operating on one or more threads in the current process.", + "thread <subcommand> [<subcommand-options>]") { LoadSubCommand ("backtrace", CommandObjectSP (new CommandObjectThreadBacktrace (interpreter))); LoadSubCommand ("continue", CommandObjectSP (new CommandObjectThreadContinue (interpreter))); @@ -2214,45 +2178,37 @@ CommandObjectMultiwordThread::CommandObjectMultiwordThread (CommandInterpreter & LoadSubCommand ("select", CommandObjectSP (new CommandObjectThreadSelect (interpreter))); LoadSubCommand ("until", CommandObjectSP (new CommandObjectThreadUntil (interpreter))); LoadSubCommand ("info", CommandObjectSP (new CommandObjectThreadInfo (interpreter))); - LoadSubCommand ("step-in", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( - interpreter, - "thread step-in", - "Source level single step in specified thread (current thread, if none specified).", - nullptr, - eStepTypeInto, - eStepScopeSource))); - - LoadSubCommand ("step-out", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( - interpreter, - "thread step-out", - "Finish executing the function of the currently selected frame and return to its call site in specified thread (current thread, if none specified).", - nullptr, - eStepTypeOut, - eStepScopeSource))); - - LoadSubCommand ("step-over", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( - interpreter, - "thread step-over", - "Source level single step in specified thread (current thread, if none specified), stepping over calls.", - nullptr, - eStepTypeOver, - eStepScopeSource))); - - LoadSubCommand ("step-inst", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( - interpreter, - "thread step-inst", - "Single step one instruction in specified thread (current thread, if none specified).", - nullptr, - eStepTypeTrace, - eStepScopeInstruction))); - - LoadSubCommand ("step-inst-over", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( - interpreter, - "thread step-inst-over", - "Single step one instruction in specified thread (current thread, if none specified), stepping over calls.", - nullptr, - eStepTypeTraceOver, - eStepScopeInstruction))); + LoadSubCommand("step-in", + CommandObjectSP(new CommandObjectThreadStepWithTypeAndScope( + interpreter, "thread step-in", + "Source level single step, stepping into calls. Defaults to current thread unless specified.", + nullptr, eStepTypeInto, eStepScopeSource))); + + LoadSubCommand("step-out", + CommandObjectSP(new CommandObjectThreadStepWithTypeAndScope( + interpreter, "thread step-out", "Finish executing the current stack frame and stop after " + "returning. Defaults to current thread unless specified.", + nullptr, eStepTypeOut, eStepScopeSource))); + + LoadSubCommand("step-over", + CommandObjectSP(new CommandObjectThreadStepWithTypeAndScope( + interpreter, "thread step-over", + "Source level single step, stepping over calls. Defaults to current thread unless specified.", + nullptr, eStepTypeOver, eStepScopeSource))); + + LoadSubCommand( + "step-inst", + CommandObjectSP(new CommandObjectThreadStepWithTypeAndScope( + interpreter, "thread step-inst", + "Instruction level single step, stepping into calls. Defaults to current thread unless specified.", + nullptr, eStepTypeTrace, eStepScopeInstruction))); + + LoadSubCommand( + "step-inst-over", + CommandObjectSP(new CommandObjectThreadStepWithTypeAndScope( + interpreter, "thread step-inst-over", + "Instruction level single step, stepping over calls. Defaults to current thread unless specified.", + nullptr, eStepTypeTraceOver, eStepScopeInstruction))); LoadSubCommand ("step-scripted", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( interpreter, diff --git a/lldb/source/Commands/CommandObjectType.cpp b/lldb/source/Commands/CommandObjectType.cpp index 0f2db74..6f1199d 100644 --- a/lldb/source/Commands/CommandObjectType.cpp +++ b/lldb/source/Commands/CommandObjectType.cpp @@ -3571,11 +3571,9 @@ private: class CommandObjectTypeFormat : public CommandObjectMultiword { public: - CommandObjectTypeFormat (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "type format", - "A set of commands for editing variable value display options", - "type format [<sub-command-options>] ") + CommandObjectTypeFormat(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "type format", "Commands for customizing value display formats.", + "type format [<sub-command-options>] ") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTypeFormatAdd (interpreter))); LoadSubCommand ("clear", CommandObjectSP (new CommandObjectTypeFormatClear (interpreter))); @@ -3596,11 +3594,10 @@ public: class CommandObjectTypeSynth : public CommandObjectMultiword { public: - CommandObjectTypeSynth (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "type synthetic", - "A set of commands for operating on synthetic type representations", - "type synthetic [<sub-command-options>] ") + CommandObjectTypeSynth(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "type synthetic", + "Commands for operating on synthetic type representations.", + "type synthetic [<sub-command-options>] ") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTypeSynthAdd (interpreter))); LoadSubCommand ("clear", CommandObjectSP (new CommandObjectTypeSynthClear (interpreter))); @@ -3621,11 +3618,9 @@ public: class CommandObjectTypeFilter : public CommandObjectMultiword { public: - CommandObjectTypeFilter (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "type filter", - "A set of commands for operating on type filters", - "type synthetic [<sub-command-options>] ") + CommandObjectTypeFilter(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "type filter", "Commands for operating on type filters.", + "type synthetic [<sub-command-options>] ") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTypeFilterAdd (interpreter))); LoadSubCommand ("clear", CommandObjectSP (new CommandObjectTypeFilterClear (interpreter))); @@ -3639,11 +3634,9 @@ public: class CommandObjectTypeCategory : public CommandObjectMultiword { public: - CommandObjectTypeCategory (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "type category", - "A set of commands for operating on categories", - "type category [<sub-command-options>] ") + CommandObjectTypeCategory(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "type category", "Commands for operating on type categories.", + "type category [<sub-command-options>] ") { LoadSubCommand ("define", CommandObjectSP (new CommandObjectTypeCategoryDefine (interpreter))); LoadSubCommand ("enable", CommandObjectSP (new CommandObjectTypeCategoryEnable (interpreter))); @@ -3658,11 +3651,9 @@ public: class CommandObjectTypeSummary : public CommandObjectMultiword { public: - CommandObjectTypeSummary (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "type summary", - "A set of commands for editing variable summary display options", - "type summary [<sub-command-options>] ") + CommandObjectTypeSummary(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "type summary", "Commands for editing variable summary display options.", + "type summary [<sub-command-options>] ") { LoadSubCommand ("add", CommandObjectSP (new CommandObjectTypeSummaryAdd (interpreter))); LoadSubCommand ("clear", CommandObjectSP (new CommandObjectTypeSummaryClear (interpreter))); @@ -3682,11 +3673,9 @@ public: // CommandObjectType //------------------------------------------------------------------------- -CommandObjectType::CommandObjectType (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "type", - "A set of commands for operating on the type system", - "type [<sub-command-options>]") +CommandObjectType::CommandObjectType(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "type", "Commands for operating on the type system.", + "type [<sub-command-options>]") { LoadSubCommand ("category", CommandObjectSP (new CommandObjectTypeCategory (interpreter))); LoadSubCommand ("filter", CommandObjectSP (new CommandObjectTypeFilter (interpreter))); diff --git a/lldb/source/Commands/CommandObjectVersion.cpp b/lldb/source/Commands/CommandObjectVersion.cpp index 70e101c..06962f86 100644 --- a/lldb/source/Commands/CommandObjectVersion.cpp +++ b/lldb/source/Commands/CommandObjectVersion.cpp @@ -24,8 +24,8 @@ using namespace lldb_private; // CommandObjectVersion //------------------------------------------------------------------------- -CommandObjectVersion::CommandObjectVersion (CommandInterpreter &interpreter) : - CommandObjectParsed (interpreter, "version", "Show version of LLDB debugger.", "version") +CommandObjectVersion::CommandObjectVersion(CommandInterpreter &interpreter) + : CommandObjectParsed(interpreter, "version", "Show the LLDB debugger version.", "version") { } diff --git a/lldb/source/Commands/CommandObjectWatchpoint.cpp b/lldb/source/Commands/CommandObjectWatchpoint.cpp index ddda3ad..977b6bb 100644 --- a/lldb/source/Commands/CommandObjectWatchpoint.cpp +++ b/lldb/source/Commands/CommandObjectWatchpoint.cpp @@ -1308,11 +1308,9 @@ private: class CommandObjectWatchpointSet : public CommandObjectMultiword { public: - CommandObjectWatchpointSet (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "watchpoint set", - "A set of commands for setting a watchpoint.", - "watchpoint set <subcommand> [<subcommand-options>]") + CommandObjectWatchpointSet(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "watchpoint set", "Commands for setting a watchpoint.", + "watchpoint set <subcommand> [<subcommand-options>]") { LoadSubCommand ("variable", CommandObjectSP (new CommandObjectWatchpointSetVariable (interpreter))); @@ -1327,11 +1325,9 @@ public: //------------------------------------------------------------------------- #pragma mark MultiwordWatchpoint -CommandObjectMultiwordWatchpoint::CommandObjectMultiwordWatchpoint(CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "watchpoint", - "A set of commands for operating on watchpoints.", - "watchpoint <command> [<command-options>]") +CommandObjectMultiwordWatchpoint::CommandObjectMultiwordWatchpoint(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "watchpoint", "Commands for operating on watchpoints.", + "watchpoint <subcommand> [<command-options>]") { CommandObjectSP list_command_object (new CommandObjectWatchpointList (interpreter)); CommandObjectSP enable_command_object (new CommandObjectWatchpointEnable (interpreter)); diff --git a/lldb/source/Commands/CommandObjectWatchpointCommand.cpp b/lldb/source/Commands/CommandObjectWatchpointCommand.cpp index 91e29ee..0ae1850 100644 --- a/lldb/source/Commands/CommandObjectWatchpointCommand.cpp +++ b/lldb/source/Commands/CommandObjectWatchpointCommand.cpp @@ -36,13 +36,12 @@ class CommandObjectWatchpointCommandAdd : public IOHandlerDelegateMultiline { public: - CommandObjectWatchpointCommandAdd (CommandInterpreter &interpreter) : - CommandObjectParsed(interpreter, - "add", - "Add a set of commands to a watchpoint, to be executed whenever the watchpoint is hit.", - nullptr), - IOHandlerDelegateMultiline("DONE", IOHandlerDelegate::Completion::LLDBCommand), - m_options (interpreter) + CommandObjectWatchpointCommandAdd(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "add", + "Add a set of LLDB commands to a watchpoint, to be executed whenever the watchpoint is hit.", nullptr), + IOHandlerDelegateMultiline("DONE", IOHandlerDelegate::Completion::LLDBCommand), + m_options(interpreter) { SetHelpLong ( R"( @@ -708,11 +707,10 @@ protected: // CommandObjectWatchpointCommand //------------------------------------------------------------------------- -CommandObjectWatchpointCommand::CommandObjectWatchpointCommand (CommandInterpreter &interpreter) : - CommandObjectMultiword (interpreter, - "command", - "A set of commands for adding, removing and examining bits of code to be executed when the watchpoint is hit (watchpoint 'commmands').", - "command <sub-command> [<sub-command-options>] <watchpoint-id>") +CommandObjectWatchpointCommand::CommandObjectWatchpointCommand(CommandInterpreter &interpreter) + : CommandObjectMultiword(interpreter, "command", "Commands for adding, removing and examining LLDB commands " + "executed when the watchpoint is hit (watchpoint 'commmands').", + "command <sub-command> [<sub-command-options>] <watchpoint-id>") { CommandObjectSP add_command_object (new CommandObjectWatchpointCommandAdd (interpreter)); CommandObjectSP delete_command_object (new CommandObjectWatchpointCommandDelete (interpreter)); |