commit 973d66eefcbbe3dc3a147f73435498846debb872
author Jonas Devlieghere <jonas@devlieghere.com> Fri May 03 00:10:31 2019 +0000
committer Jonas Devlieghere <jonas@devlieghere.com> Fri May 03 00:10:31 2019 +0000
tree 11719242e94bc66e2bf39333c4ca96043d0af86e
parent c9f44cd4b6e590c5884a2bc2465d4a09ac4f1c59

[Reproducers] Improve reproducer help

Extend the documentation for the reproducer command.

llvm-svn: 359848

lldb/source/Commands/CommandObjectReproducer.cpp

diff --git a/lldb/source/Commands/CommandObjectReproducer.cpp b/lldb/source/Commands/CommandObjectReproducer.cpp
index c80a858..4b0e9e3 100644
--- a/lldb/source/Commands/CommandObjectReproducer.cpp
+++ b/lldb/source/Commands/CommandObjectReproducer.cpp
@@ -21,8 +21,12 @@
 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 @@
 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 @@
 
 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)));