From 2fb9cbad0c88dbc3f2db86e2490fca40bc6b47bf Mon Sep 17 00:00:00 2001 From: Gabriel Schneider Date: Tue, 17 Nov 2026 13:11:46 -0300 Subject: README: a package that uses cloud9, as test/consumer does The README and 9proc's told a consumer to pass .target and .optimize to b.dependency("cloud9", ...), and to swap the URL pin for a path while working on both packages. Now: the two modules take no options, and the whole build.zig of a program on cloud9 is written out (eleven lines, the form test/consumer uses); nothing else of cloud9's build runs in it. The sibling checkout is Zig's --fork=../cloud9, with the manifest untouched. Checked outside the tree: that build.zig, in a package pinning cloud9 by URL and hash (pardes's pin, 7f418a6b, from a copy of its zig-pkg entry), builds and runs; with --fork= it builds against this one ("fork ... matched 1 cloud9 packages", and no jj or date at configure); and against this tree as a fetched package (a tarball of its tracked files, so the manifest's paths filter applies) it builds too. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_016Y9MNBECMWcJD5pdS4SR6T --- README.md | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4aa4887..aa9448d 100644 --- a/README.md +++ b/README.md @@ -59,17 +59,31 @@ zig fetch --save=cloud9 git+https://git.sr.ht/~gbrls/cloud9# The toolchain has no `git+ssh` support, so the manifest carries the read-only HTTPS URL. Push to `git@git.sr.ht:~gbrls/cloud9`. For work on both packages at -once, substitute `.cloud9 = .{ .path = "../cloud9" }` while editing, then -re-pin. Either way, import the module the same way: +once, build against the checkout without touching the manifest: +`zig build --fork=../cloud9`. + +The package exports two modules, `cloud9` and `9proc`, with no target or +optimize of their own: they compile for whatever imports them, so the +dependency takes no options. The whole `build.zig` of a program on cloud9: ```zig -const cloud9 = b.dependency("cloud9", .{ - .target = target, - .optimize = optimize, -}).module("cloud9"); -app.root_module.addImport("cloud9", cloud9); +const std = @import("std"); + +pub fn build(b: *std.Build) void { + const exe = b.addExecutable(.{ .name = "srv", .root_module = b.createModule(.{ + .root_source_file = b.path("src/main.zig"), + .target = b.standardTargetOptions(.{}), + .optimize = b.standardOptimizeOption(.{}), + .imports = &.{.{ .name = "cloud9", .module = b.dependency("cloud9", .{}).module("cloud9") }}, + }) }); + b.installArtifact(exe); +} ``` +Nothing else of cloud9's build runs in yours: its tests and programs are +configured only when it is the root. [`test/consumer`](test/consumer/build.zig) +is such a package, and cloud9's `zig build test` builds and runs it. + Start a client with `Client.init(.{ .in = input_buffer, .out = output_buffer })`. Submit `.version` first. Drain `output()` through your transport and report the number sent with `wrote()`. Feed received bytes using `push()` and collect tagged @@ -151,9 +165,9 @@ enabled program's unit and integration steps. A dependent package gets both modules from the one dependency: ```zig -const cloud9_dep = b.dependency("cloud9", .{ .target = target, .optimize = optimize }); -app.root_module.addImport("cloud9", cloud9_dep.module("cloud9")); -app.root_module.addImport("9proc", cloud9_dep.module("9proc")); +const cloud9 = b.dependency("cloud9", .{}); +app.root_module.addImport("cloud9", cloud9.module("cloud9")); +app.root_module.addImport("9proc", cloud9.module("9proc")); ``` See [design and ownership contracts](docs/design.md), -- cgit v1.3