From 351c3976805aa12a56c593894738001491548106 Mon Sep 17 00:00:00 2001 From: Gabriel Schneider Date: Thu, 1 Oct 2026 10:45:29 -0300 Subject: The docs trimmed to their path: a guide with Words you'll see and one Where commands run and panes go table, scripting's first tag word Fmt and eight traps, setup as the one home of the pager and the servers, a scannable cheatsheet, an honest README, the edge cases moved to the reference, and the pager's colours Co-Authored-By: Claude Opus 5.5 --- docs/typ/building.typ | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/typ/building.typ') diff --git a/docs/typ/building.typ b/docs/typ/building.typ index 6a2758ad..d957ff94 100644 --- a/docs/typ/building.typ +++ b/docs/typ/building.typ @@ -56,7 +56,7 @@ there; its namespace is in `src/esp32p4_gpio.zig`. [`-Dtest-filter`], [run only tests whose name contains it; a filter that matches nothing fails], [`-Dtest-rebuild`], [bool: fresh Zig test compilation], [`-Dhelix-harness`], [reference executable for live differential tests; `HX_HARNESS`, else `hx-harness` on `PATH`], - [`-Desp32p4-cols`, `-Desp32p4-rows`], [the board's grid, 56 by 14], + [`-Desp32p4-cols`, `-Desp32p4-rows`], [the ESP32-P4's grid, 56 by 14], ) = Tests @@ -145,7 +145,7 @@ effects such as spawning processes. - The root module is chosen by platform: `main.zig` (tty, gui), `web.zig`, `macos.zig`, `esp32p4.zig`. The web and macOS shells are libraries whose host owns `main()`. -- `memory.limits` is the one home for capacities that differ on the board +- `memory.limits` is the one home for capacities that differ on the ESP32-P4 (panes 16, columns 6, selections 64, the tag's 512 bytes). Each core allocator is a thread-safe stack-fallback allocator, under a DebugAllocator in Debug builds. @@ -172,7 +172,7 @@ selection-pipe workers post completions through a bounded mailbox; a `host_io.Lsp.Job` owns copies of the source, path and arguments, never reading the live core, and a request id, the pane's serial and (for an edit) the file's revision reject a stale reply. A process that never calls -`turn.start` (the tests, the board, the browser) has no second thread. +`turn.start` (the tests, the ESP32-P4, the browser) has no second thread. == Detached sessions @@ -211,9 +211,9 @@ use `.cloud9 = .{ .path = "../cloud9" }` while editing both. cloud9's own calls. The control tree in `src/ninep/` is its backend: `tree.zig` (nodes, dispatch), `pane.zig`, `ctl.zig`, `cols.zig`, `addr.zig`, `pty.zig`, `events.zig` (event and log), `screen.zig`, `sources.zig`. - `src/9p.zig` names the editor's and the board's engine settings: msize + `src/9p.zig` names the editor's and the ESP32-P4's engine settings: msize 65536, 256 fids, 128 held reads a connection, names up to 255 bytes; the - board has 32 fids. + ESP32-P4 has 32 fids. - A read, write, open, clunk, remove or truncating wstat can park; a walk, attach, stat, create or rename cannot. Every Rread is clamped to the count and the msize; Tflush answers the original request first. -- cgit v1.3