diff --git a/.gitignore b/.gitignore index ee7098f..9ad6b22 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ zig-out/ zig-cache/ +.zig-cache/ diff --git a/build.zig b/build.zig index 29cdf78..f455a00 100644 --- a/build.zig +++ b/build.zig @@ -16,10 +16,10 @@ pub fn build(b: *std.Build) void { const optimize = b.standardOptimizeOption(.{}); const util_dep = b.dependency("zba-util", .{}); // https://git.musuka.dev/paoda/zba-util - const bitfield_mod = b.createModule(.{ .root_source_file = .{ .path = "lib/bitfield.zig" } }); // https://github.com/FlorenceOS/Florence + const bitfield_mod = b.createModule(.{ .root_source_file = b.path("lib/bitfield.zig") }); // https://github.com/FlorenceOS/Florence _ = b.addModule("arm32", .{ - .root_source_file = .{ .path = "src/lib.zig" }, + .root_source_file = b.path("src/lib.zig"), .imports = &.{ .{ .name = "zba-util", .module = util_dep.module("zba-util") }, .{ .name = "bitfield", .module = bitfield_mod }, @@ -28,20 +28,20 @@ pub fn build(b: *std.Build) void { // Creates a step for unit testing. This only builds the test executable // but does not run it. - const tests = b.addTest(.{ - .root_source_file = .{ .path = "src/lib.zig" }, + const lib_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/lib.zig"), .target = target, .optimize = optimize, }); - tests.root_module.addImport("zba-util", util_dep.module("zba-util")); - tests.root_module.addImport("bitfield", bitfield_mod); + lib_unit_tests.root_module.addImport("zba-util", util_dep.module("zba-util")); + lib_unit_tests.root_module.addImport("bitfield", bitfield_mod); - const run_tests = b.addRunArtifact(tests); + const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests); - // This creates a build step. It will be visible in the `zig build --help` menu, - // and can be selected like this: `zig build test` - // This will evaluate the `test` step rather than the default, which is "install". - const test_step = b.step("test", "Run library tests"); - test_step.dependOn(&run_tests.step); + // Similar to creating the run step earlier, this exposes a `test` step to + // the `zig build --help` menu, providing a way for the user to request + // running the unit tests. + const test_step = b.step("test", "Run unit tests"); + test_step.dependOn(&run_lib_unit_tests.step); } diff --git a/build.zig.zon b/build.zig.zon index 83dc384..5476486 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -1,16 +1,77 @@ .{ - .name = "arm32", + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save `, this field is used + // as the key in the `dependencies` table. Although the user can choose a + // different name, most users will stick with this provided value. + // + // It is redundant to include "zig" in this name because it is already + // within the Zig package namespace. + .name = "zba-util", + + // This is a [Semantic Version](https://semver.org/). + // In a future version of Zig it will be used for package deduplication. .version = "0.1.0", + + // This field is optional. + // This is currently advisory only; Zig does not yet do anything + // with this value. + //.minimum_zig_version = "0.11.0", + + // This field is optional. + // Each dependency must either provide a `url` and `hash`, or a `path`. + // `zig build --fetch` can be used to fetch all dependencies of a package, recursively. + // Once all dependencies are fetched, `zig build` no longer requires + // internet connectivity. + .dependencies = .{ + // See `zig fetch --save ` for a command-line interface for adding dependencies. + //.example = .{ + // // When updating this field to a new URL, be sure to delete the corresponding + // // `hash`, otherwise you are communicating that you expect to find the old hash at + // // the new URL. + // .url = "https://example.com/foo.tar.gz", + // + // // This is computed from the file contents of the directory of files that is + // // obtained after fetching `url` and applying the inclusion rules given by + // // `paths`. + // // + // // This field is the source of truth; packages do not come from a `url`; they + // // come from a `hash`. `url` is just one of many possible mirrors for how to + // // obtain a package matching this `hash`. + // // + // // Uses the [multihash](https://multiformats.io/multihash/) format. + // .hash = "...", + // + // // When this is provided, the package is found in a directory relative to the + // // build root. In this case the package's hash is irrelevant and therefore not + // // computed. This field and `url` are mutually exclusive. + // .path = "foo", + + // // When this is set to `true`, a package is declared to be lazily + // // fetched. This makes the dependency only get fetched if it is + // // actually used. + // .lazy = false, + //}, + .@"zba-util" = .{ + .url = "https://git.musuka.dev/paoda/zba-util/archive/bf0e744047ce1ec90172dbcc0c72bfcc29a063e3.tar.gz", + .hash = "1220d044ecfbeacc3b3cebeff131d587e24167d61435a3cb96dffd4d4521bb06aed0", + }, + }, + + // Specifies the set of files and directories that are included in this package. + // Only files and directories listed here are included in the `hash` that + // is computed for this package. Only files listed here will remain on disk + // when using the zig package manager. As a rule of thumb, one should list + // files required for compilation plus any license(s). + // Paths are relative to the build root. Use the empty string (`""`) to refer to + // the build root itself. + // A directory listed here means that all files within, recursively, are included. .paths = .{ "build.zig", "build.zig.zon", - "lib/bitfield.zig", "src", - }, - .dependencies = .{ - .@"zba-util" = .{ - .url = "https://git.musuka.dev/paoda/zba-util/archive/7ebaf2854a2d31ef30691427681286e35130b1ae.tar.gz", - .hash = "12206ea1b29665cecb78bf2c269d1d0ed0a9b6f5f1dffe2aceaddd1cd8abc13a2f08", - }, + "lib/bitfield.zig", + // For example... + //"LICENSE", + //"README.md", }, }