aboutsummaryrefslogtreecommitdiff
path: root/build.zig
diff options
context:
space:
mode:
authorAndrew Kelley <andrew@ziglang.org>2023-03-01 22:56:37 -0700
committerAndrew Kelley <andrew@ziglang.org>2023-03-15 10:48:13 -0700
commit58edefc6d1716c0731ee2fe672ec8d073651aafb (patch)
tree9de4d030be9f44d3bc953d114eaef0812bd11cf4 /build.zig
parentd0f675827c28b1d50e8aea6a7d29cb45ad8d4e67 (diff)
downloadzig-58edefc6d1716c0731ee2fe672ec8d073651aafb.tar.gz
zig-58edefc6d1716c0731ee2fe672ec8d073651aafb.zip
zig build: many enhancements related to parallel building
Rework std.Build.Step to have an `owner: *Build` field. This simplified the implementation of installation steps, as well as provided some much-needed common API for the new parallelized build system. --verbose is now defined very concretely: it prints to stderr just before spawning a child process. Child process execution is updated to conform to the new parallel-friendly make() function semantics. DRY up the failWithCacheError handling code. It now integrates properly with the step graph instead of incorrectly dumping to stderr and calling process exit. In the main CLI, fix `zig fmt` crash when there are no errors and stdin is used. Deleted steps: * EmulatableRunStep - this entire thing can be removed in favor of a flag added to std.Build.RunStep called `skip_foreign_checks`. * LogStep - this doesn't really fit with a multi-threaded build runner and is effectively superseded by the new build summary output. build runner: * add -fsummary and -fno-summary to override the default behavior, which is to print a summary if any of the build steps fail. * print the dep prefix when emitting error messages for steps. std.Build.FmtStep: * This step now supports exclude paths as well as a check flag. * The check flag decides between two modes, modify mode, and check mode. These can be used to update source files in place, or to fail the build, respectively. Zig's own build.zig: * The `test-fmt` step will do all the `zig fmt` checking that we expect to be done. Since the `test` step depends on this one, we can simply remove the explicit call to `zig fmt` in the CI. * The new `fmt` step will actually perform `zig fmt` and update source files in place. std.Build.RunStep: * expose max_stdio_size is a field (previously an unchangeable hard-coded value). * rework the API. Instead of configuring each stream independently, there is a `stdio` field where you can choose between `infer_from_args`, `inherit`, or `check`. These determine whether the RunStep is considered to have side-effects or not. The previous field, `condition` is gone. * when stdio mode is set to `check` there is a slice of any number of checks to make, which include things like exit code, stderr matching, or stdout matching. * remove the ill-defined `print` field. * when adding an output arg, it takes the opportunity to give itself a better name. * The flag `skip_foreign_checks` is added. If this is true, a RunStep which is configured to check the output of the executed binary will not fail the build if the binary cannot be executed due to being for a foreign binary to the host system which is running the build graph. Command-line arguments such as -fqemu and -fwasmtime may affect whether a binary is detected as foreign, as well as system configuration such as Rosetta (macOS) and binfmt_misc (Linux). - This makes EmulatableRunStep no longer needed. * Fix the child process handling to properly integrate with the new bulid API and to avoid deadlocks in stdout/stderr streams by polling if necessary. std.Build.RemoveDirStep now uses the open build_root directory handle instead of an absolute path.
Diffstat (limited to 'build.zig')
-rw-r--r--build.zig24
1 files changed, 18 insertions, 6 deletions
diff --git a/build.zig b/build.zig
index 189f50407d..5f7e214d35 100644
--- a/build.zig
+++ b/build.zig
@@ -61,8 +61,6 @@ pub fn build(b: *std.Build) !void {
test_cases.stack_size = stack_size;
test_cases.single_threaded = single_threaded;
- const fmt_build_zig = b.addFmt(&[_][]const u8{"build.zig"});
-
const skip_debug = b.option(bool, "skip-debug", "Main test suite skips debug builds") orelse false;
const skip_release = b.option(bool, "skip-release", "Main test suite skips release builds") orelse false;
const skip_release_small = b.option(bool, "skip-release-small", "Main test suite skips release-small builds") orelse skip_release;
@@ -386,10 +384,24 @@ pub fn build(b: *std.Build) !void {
}
const optimization_modes = chosen_opt_modes_buf[0..chosen_mode_index];
- // run stage1 `zig fmt` on this build.zig file just to make sure it works
- test_step.dependOn(&fmt_build_zig.step);
- const fmt_step = b.step("test-fmt", "Run zig fmt against build.zig to make sure it works");
- fmt_step.dependOn(&fmt_build_zig.step);
+ const fmt_include_paths = &.{ "doc", "lib", "src", "test", "tools", "build.zig" };
+ const fmt_exclude_paths = &.{ "test/cases" };
+ const check_fmt = b.addFmt(.{
+ .paths = fmt_include_paths,
+ .exclude_paths = fmt_exclude_paths,
+ .check = true,
+ });
+ const do_fmt = b.addFmt(.{
+ .paths = fmt_include_paths,
+ .exclude_paths = fmt_exclude_paths,
+ });
+
+ const test_fmt_step = b.step("test-fmt", "Check whether source files have conforming formatting");
+ test_fmt_step.dependOn(&check_fmt.step);
+
+ const do_fmt_step = b.step("fmt", "Modify source files in place to have conforming formatting");
+ do_fmt_step.dependOn(&do_fmt.step);
+
test_step.dependOn(tests.addPkgTests(
b,