cpp: fix documentation wording for data members in GlobalVariables
Some had incorrect words, or were missing a word and the end period.
Make it match with the descriptions in CommonCommandOptions.java.
Add a short documentation comment to |restart_reason| field.
--
Change-Id: Iac802eb3ed4f72dfd402e85d2098a5616b40a9de
Reviewed-on: https://bazel-review.googlesource.com/3530
MOS_MIGRATED_REVID=121478703
diff --git a/src/main/cpp/blaze_globals.h b/src/main/cpp/blaze_globals.h
index f8dc24a..fdadea1 100644
--- a/src/main/cpp/blaze_globals.h
+++ b/src/main/cpp/blaze_globals.h
@@ -31,7 +31,7 @@
namespace blaze {
// The reason for a blaze server restart.
-// Keep in sync with logging.proto
+// Keep in sync with logging.proto.
enum RestartReason {
NO_RESTART = 0,
NO_DAEMON,
@@ -68,23 +68,25 @@
// populated during GetInstallBase().
vector<string> extracted_binaries;
- // Parsed startup options
+ // Parsed startup options.
BlazeStartupOptions options;
- // The time in ms the launcher spends before sending the request to the Blaze
+ // The time in ms the launcher spends before sending the request to the blaze
+ // server.
uint64_t startup_time;
- // The time spent on extracting the new blaze version
- // This is part of startup_time
+ // The time in ms spent on extracting the new blaze version.
+ // This is part of startup_time.
uint64_t extract_data_time;
- // The time in ms if a command had to wait on a busy Blaze server process
- // This is part of startup_time
+ // The time in ms a command had to wait on a busy Blaze server process.
+ // This is part of startup_time.
uint64_t command_wait_time;
+ // The reason for the server restart.
RestartReason restart_reason;
- // Absolute path of the blaze binary
+ // The absolute path of the blaze binary.
string binary_path;
// MD5 hash of the Blaze binary (includes deploy.jar, extracted binaries, and
diff --git a/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java b/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java
index 68df6a7..fb521ae 100644
--- a/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java
@@ -212,10 +212,12 @@
help = "The time in ms the launcher spends before sending the request to the blaze server.")
public long startupTime;
- @Option(name = "extract_data_time",
- defaultValue = "0",
- category = "hidden",
- help = "The time spend on extracting the new blaze version.")
+ @Option(
+ name = "extract_data_time",
+ defaultValue = "0",
+ category = "hidden",
+ help = "The time in ms spent on extracting the new blaze version."
+ )
public long extractDataTime;
@Option(name = "command_wait_time",
