Skip to content

Commit

Permalink
[7.4.0] Declare the compact execution log format to be stable.
Browse files Browse the repository at this point in the history
Fixes bazelbuild#18643.

PiperOrigin-RevId: 678723961
Change-Id: I3da378d2009de2632228d1e914ae451c96cf5b75
  • Loading branch information
tjgq committed Oct 1, 2024
1 parent 61f49cc commit ed0e999
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ private void initOutputs(CommandEnvironment env) throws IOException {
if (numFormats > 1) {
String message =
"Must specify at most one of --execution_log_binary_file, --execution_log_json_file and"
+ " --experimental_execution_log_compact_file";
+ " --execution_log_compact_file";
env.getBlazeModuleEnvironment()
.exit(
new AbruptExitException(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,9 @@ public boolean usingLocalTestJobs() {
converter = OptionsUtils.EmptyToNullPathFragmentConverter.class,
help =
"Log the executed spawns into this file as length-delimited SpawnExec protos, according"
+ " to src/main/protobuf/spawn.proto. Related flags:"
+ " to src/main/protobuf/spawn.proto. Prefer --execution_log_compact_file, which is"
+ " significantly smaller and cheaper to produce. Related flags:"
+ " --execution_log_compact_file (compact format; mutually exclusive),"
+ " --execution_log_json_file (text JSON format; mutually exclusive),"
+ " --execution_log_sort (whether to sort the execution log),"
+ " --subcommands (for displaying subcommands in terminal output).")
Expand All @@ -457,14 +459,18 @@ public boolean usingLocalTestJobs() {
converter = OptionsUtils.EmptyToNullPathFragmentConverter.class,
help =
"Log the executed spawns into this file as newline-delimited JSON representations of"
+ " SpawnExec protos, according to src/main/protobuf/spawn.proto. Related flags:"
+ " SpawnExec protos, according to src/main/protobuf/spawn.proto. Prefer"
+ " --execution_log_compact_file, which is significantly smaller and cheaper to"
+ " produce. Related flags:"
+ " --execution_log_compact_file (compact format; mutually exclusive),"
+ " --execution_log_binary_file (binary protobuf format; mutually exclusive),"
+ " --execution_log_sort (whether to sort the execution log),"
+ " --subcommands (for displaying subcommands in terminal output).")
public PathFragment executionLogJsonFile;

@Option(
name = "experimental_execution_log_compact_file",
name = "execution_log_compact_file",
oldName = "experimental_execution_log_compact_file",
defaultValue = "null",
category = "verbosity",
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
Expand All @@ -473,8 +479,7 @@ public boolean usingLocalTestJobs() {
help =
"Log the executed spawns into this file as length-delimited ExecLogEntry protos,"
+ " according to src/main/protobuf/spawn.proto. The entire file is zstd compressed."
+ " This is an experimental format under active development, and may change at any"
+ " time. Related flags:"
+ " Related flags:"
+ " --execution_log_binary_file (binary protobuf format; mutually exclusive),"
+ " --execution_log_json_file (text JSON format; mutually exclusive),"
+ " --subcommands (for displaying subcommands in terminal output).")
Expand Down

0 comments on commit ed0e999

Please sign in to comment.