[Reproducers] Improve reproducer help

Extend the documentation for the reproducer command.

llvm-svn: 359848
This commit is contained in:
Jonas Devlieghere 2019-05-03 00:10:31 +00:00
parent c9f44cd4b6
commit 973d66eefc

View File

@ -21,8 +21,12 @@ using namespace lldb_private;
class CommandObjectReproducerGenerate : public CommandObjectParsed {
public:
CommandObjectReproducerGenerate(CommandInterpreter &interpreter)
: CommandObjectParsed(interpreter, "reproducer generate",
"Generate reproducer on disk.", nullptr) {}
: CommandObjectParsed(
interpreter, "reproducer generate",
"Generate reproducer on disk. When the debugger is in capture "
"mode, this command will output the reproducer to a directory on "
"disk. In replay mode this command in a no-op.",
nullptr) {}
~CommandObjectReproducerGenerate() override = default;
@ -61,8 +65,14 @@ protected:
class CommandObjectReproducerStatus : public CommandObjectParsed {
public:
CommandObjectReproducerStatus(CommandInterpreter &interpreter)
: CommandObjectParsed(interpreter, "reproducer status",
"Show the current reproducer status.", nullptr) {}
: CommandObjectParsed(
interpreter, "reproducer status",
"Show the current reproducer status. In capture mode the debugger "
"is collecting all the information it needs to create a "
"reproducer. In replay mode the reproducer is replaying a "
"reproducer. When the reproducers are off, no data is collected "
"and no reproducer can be generated.",
nullptr) {}
~CommandObjectReproducerStatus() override = default;
@ -90,9 +100,10 @@ protected:
CommandObjectReproducer::CommandObjectReproducer(
CommandInterpreter &interpreter)
: CommandObjectMultiword(interpreter, "reproducer",
"Commands controlling LLDB reproducers.",
"log <subcommand> [<command-options>]") {
: CommandObjectMultiword(
interpreter, "reproducer",
"Commands to inspect and manipulate the reproducer functionality.",
"log <subcommand> [<command-options>]") {
LoadSubCommand(
"generate",
CommandObjectSP(new CommandObjectReproducerGenerate(interpreter)));