Review feedback: update docs/comments

oschaaf · oschaaf · commit bb70db154224 · 2020-01-24T20:16:54.000+01:00
Signed-off-by: Otto van der Schaaf &lt;oschaaf@we-amp.com&gt;
diff --git a/README.md b/README.md
@@ -79,7 +79,9 @@ format>
 Where:
 
 --simple-warmup
-Do not perform the simple warmup call.
+Perform a simple single warmup request (per worker) before starting
+execution. Note that this will be reflected in the counters that
+Nighthawk writes to the output. Default is false.
 
 --request-source <uri format>
 Remote gRPC source that will deliver to-be-replayed traffic. Each
diff --git a/api/client/options.proto b/api/client/options.proto
@@ -187,6 +187,8 @@ message CommandLineOptions {
   repeated string labels = 28;
   // TransportSocket configuration to use in every request
   envoy.config.core.v3.TransportSocket transport_socket = 27;
-  // Do not perform the simple warmup call.
+  // Perform a simple single warmup request (per worker) before starting
+  // execution. Note that this will be reflected in the counters that
+  // Nighthawk writes to the output. Default is false.
   google.protobuf.BoolValue simple_warmup = 32;
 }
diff --git a/source/client/options_impl.cc b/source/client/options_impl.cc
@@ -264,8 +264,12 @@ OptionsImpl::OptionsImpl(int argc, const char* const* argv) {
       "connect to this source. For example grpc://127.0.0.1:8443/.",
       false, "", "uri format", cmd);
 
-  TCLAP::SwitchArg simple_warmup("", "simple-warmup", "Do not perform the simple warmup call.",
-                                 cmd);
+  TCLAP::SwitchArg simple_warmup(
+      "", "simple-warmup",
+      "Perform a simple single warmup request (per worker) before starting execution. Note that "
+      "this will be reflected in the counters that Nighthawk writes to the output. Default is "
+      "false.",
+      cmd);
 
   Utility::parseCommand(cmd, argc, argv);
 
