authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2023-12-26 19:27:15-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2024-01-01 19:49:07-07:00
log190f6038bfca5e6239635cfeebd87d67d2501ea3
tree99da329d57b7af92edc13fa3ce11c3bb7bc4caa8
parent5e2035da145f2c758be26ee9817473b97274c34d

zig build: reintroduce --prominent-compile-errors

This reintroduced flag makes zig build behave the same as the previous commit. Without this flag, the default behavior is now changed to display compilation errors inline with the rest of error messages and the build tree context. This behavior is essential for making sense of error logs from projects that have two or more steps emitting compilation errors which is why it is now the default.

2 files changed, 18 insertions(+), 3 deletions(-)

lib/build_runner.zig+17-3
......@@ -99,6 +99,7 @@ pub fn main() !void {
9999 var skip_oom_steps: bool = false;
100100 var color: Color = .auto;
101101 var seed: u32 = 0;
102 var prominent_compile_errors: bool = false;
102103
103104 const stderr_stream = io.getStdErr().writer();
104105 const stdout_stream = io.getStdOut().writer();
......@@ -242,6 +243,8 @@ pub fn main() !void {
242243 builder.verbose_cc = true;
243244 } else if (mem.eql(u8, arg, "--verbose-llvm-cpu-features")) {
244245 builder.verbose_llvm_cpu_features = true;
246 } else if (mem.eql(u8, arg, "--prominent-compile-errors")) {
247 prominent_compile_errors = true;
245248 } else if (mem.eql(u8, arg, "-fwine")) {
246249 builder.enable_wine = true;
247250 } else if (mem.eql(u8, arg, "-fno-wine")) {
......@@ -325,6 +328,7 @@ pub fn main() !void {
325328 .max_rss_mutex = .{},
326329 .skip_oom_steps = skip_oom_steps,
327330 .memory_blocked_steps = std.ArrayList(*Step).init(arena),
331 .prominent_compile_errors = prominent_compile_errors,
328332
329333 .claimed_rss = 0,
330334 .summary = summary,
......@@ -357,6 +361,7 @@ const Run = struct {
357361 max_rss_mutex: std.Thread.Mutex,
358362 skip_oom_steps: bool,
359363 memory_blocked_steps: std.ArrayList(*Step),
364 prominent_compile_errors: bool,
360365
361366 claimed_rss: usize,
362367 summary: ?Summary,
......@@ -561,7 +566,7 @@ fn runStepNames(
561566 // Finally, render compile errors at the bottom of the terminal.
562567 // We use a separate compile_error_steps array list because step_stack is destructively
563568 // mutated in printTreeStep above.
564 if (total_compile_errors > 0) {
569 if (run.prominent_compile_errors and total_compile_errors > 0) {
565570 for (compile_error_steps.items) |s| {
566571 if (s.result_error_bundle.errorMessageCount() > 0) {
567572 s.result_error_bundle.renderToStdErr(renderOptions(ttyconf));
......@@ -910,7 +915,11 @@ fn workerMakeOneStep(
910915 const make_result = s.make(&sub_prog_node);
911916
912917 // No matter the result, we want to display error/warning messages.
913 if (s.result_error_msgs.items.len > 0) {
918 const show_compile_errors = !run.prominent_compile_errors and
919 s.result_error_bundle.errorMessageCount() > 0;
920 const show_error_msgs = s.result_error_msgs.items.len > 0;
921
922 if (show_error_msgs or show_compile_errors) {
914923 sub_prog_node.context.lock_stderr();
915924 defer sub_prog_node.context.unlock_stderr();
916925
......@@ -1003,7 +1012,11 @@ fn printErrorMessages(b: *std.Build, failing_step: *Step, run: *const Run) !void
10031012 }
10041013 try ttyconf.setColor(stderr, .reset);
10051014
1006 // Finally, the actual error messages.
1015 // Penultimately, the compilation errors.
1016 if (!run.prominent_compile_errors and failing_step.result_error_bundle.errorMessageCount() > 0)
1017 try failing_step.result_error_bundle.renderToWriter(renderOptions(ttyconf), stderr.writer());
1018
1019 // Finally, generic error messages.
10071020 for (failing_step.result_error_msgs.items) |msg| {
10081021 try ttyconf.setColor(stderr, .red);
10091022 try stderr.writeAll("error: ");
......@@ -1078,6 +1091,7 @@ fn usage(builder: *std.Build, already_ran_build: bool, out_stream: anytype) !voi
10781091 \\ -l, --list-steps Print available steps
10791092 \\ --verbose Print commands before executing them
10801093 \\ --color [auto|off|on] Enable or disable colored error messages
1094 \\ --prominent-compile-errors Buffer compile errors and display at end
10811095 \\ --summary [mode] Control the printing of the build summary
10821096 \\ all Print the build summary in its entirety
10831097 \\ failures (Default) Only print failed steps
src/main.zig+1
......@@ -5096,6 +5096,7 @@ pub const usage_build =
50965096 \\ --global-cache-dir [path] Override path to global Zig cache directory
50975097 \\ --zig-lib-dir [arg] Override path to Zig lib directory
50985098 \\ --build-runner [file] Override path to build runner
5099 \\ --prominent-compile-errors Buffer compile errors and display at end
50995100 \\ --seed [integer] For shuffling dependency traversal order (default: random)
51005101 \\ --fetch Exit after fetching dependency tree
51015102 \\ -h, --help Print this help and exit