summaryrefslogtreecommitdiff
path: root/docs/typ/building.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-11-04 23:13:41 -0300
committerGabriel Schneider <[email protected]>2026-11-05 00:58:19 -0300
commit1e1212c86a13d3087a5db61e9f2a28cfcba4cc45 (patch)
treeff355c2d86482e1d21280fca2fc0fade773aa6c8 /docs/typ/building.typ
parent6a665eb3d9b6542bc1765f57f19cd2fc8ce04e82 (diff)
downloadpardes-1e1212c86a13d3087a5db61e9f2a28cfcba4cc45.tar.gz
pardes-1e1212c86a13d3087a5db61e9f2a28cfcba4cc45.zip
9p_io, build: 9P over QUIC is gone: src/9p_quic.zig, the Listener's poll path on the editor's thread (its accept, fill, flush and watcher thread), the Client's quic! dials, -Dquic with its OpenSSL linking, the quic-test step that ran no test, Namespace.quic_address and /listeners' quic row, the QUIC process case, the perf baselines' quic key and every mention in the docs; main.zig still parses --9p-quic until the processes change takes it out, so 9p_io.quic_enabled stays, false, until then
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
Diffstat (limited to 'docs/typ/building.typ')
-rw-r--r--docs/typ/building.typ22
1 files changed, 7 insertions, 15 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index 99a83589..78cdba7e 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -12,8 +12,7 @@ pieces fit. To install it, see #doc("setup", section: "install").
Zig *0.17.0* (`build.zig.zon` pins `minimum_zig_version`). Dependencies are
fetched and pinned by the manifest; the terminal build needs no system
package. The SDL shell builds SDL3 and FreeType from source. PDF support
-builds MuPDF and is on by default (`-Dmupdf=false` drops it). 9P over QUIC
-(`-Dquic=true`) uses system OpenSSL 3.6+ and pkg-config.
+builds MuPDF and is on by default (`-Dmupdf=false` drops it).
#pairs(
[`zig build`], [the terminal shell and the SDL window together, *installed into `~/.local/bin`* (`pardes` and `pardes-gui`)],
@@ -47,7 +46,6 @@ there; its namespace is in `src/esp32p4_gpio.zig`.
#pairs(
[`-Dplatform`], [`tui`, `gui`, `web`, `macos`, `esp32p4`; absent: the tui and SDL shells together, installed into `~/.local`],
[`-Dstatic`], [bool, `false`],
- [`-Dquic`], [bool, `false`: 9P over QUIC with system OpenSSL 3.6+],
[`-Dmupdf`], [bool; on natively, off for web and esp32p4],
[`-Djpx`], [bool, `true`: JPEG 2000, and with it scanned PDFs],
[`-Dtree-sitter`], [`disabled`, `zig`, `minimal`, `full`; `full` natively, `zig` for web, `disabled` for esp32p4],
@@ -87,7 +85,6 @@ zig build gui-golden the hidden window's scenes against this machine's gol
zig build monkey-session random in-process 9P requests checking the documented rules
zig build 9p-test freestanding protocol tests
zig build 9p-io-test native 9P transports and client
-zig build quic-test -Dquic=true optional QUIC transport tests
zig build snap scripted input traces against frozen golden grids
zig build monkey random snapshot scripts hunting panics (not a gate)
zig build hxdiff differential suite against helix's own behaviour
@@ -254,13 +251,13 @@ registry on its command line. `python3 -B test/daemon.py --upgrade <old>
= 9P
The wire format, the client and server connections, the file-server engine
-and the Unix, TCP and QUIC transports are the `cloud9` package
+and the Unix and TCP transports are the `cloud9` package
(`git.sr.ht/~gbrls/cloud9`), pinned in `build.zig.zon` and fetched into
`zig-pkg/`. Re-pin with
`zig fetch --save=cloud9 git+https://git.sr.ht/~gbrls/cloud9#<commit>`, or
use `.cloud9 = .{ .path = "../cloud9" }` while editing both. cloud9's own
-`zig build test`, `transport-test`, `quic-test -Dquic=true`, `fuzz` and
-`differential` cover the shared code.
+`zig build test`, `transport-test`, `fuzz` and `differential` cover the
+shared code.
- The engine (`fs.Server`) owns fids, permissions, directory reads,
flushes and what a hangup releases; it allocates nothing and makes no OS
@@ -274,9 +271,7 @@ use `.cloud9 = .{ .path = "../cloud9" }` while editing both. cloud9's own
attach, stat, create or rename cannot. Every Rread is clamped to the
count and the msize; Tflush answers the original request first.
- Unix and TCP listeners run on cloud9's `serve.Runner`: an accept task per
- listener, a reader and a writer task per connection, 16 connections. QUIC
- (`src/9p_quic.zig`) still runs on the editor's poll loop in
- `src/9p_io.zig`.
+ listener, a reader and a writer task per connection, 16 connections.
- A body write takes only whole UTF-8 sequences and answers a short count
for the rest. Consecutive writes from one open at the end of the text are
held and applied as one edit, flushed by any other request, the open's
@@ -296,15 +291,12 @@ its newline, is dropped.
== Listeners <listeners>
-`--9p-tcp='tcp!127.0.0.1!5640'` adds TCP; `--9p-quic='quic!127.0.0.1!5641'`
-adds QUIC (built with `-Dquic=true`; ALPN `pardes-9p`, an ephemeral TLS
-identity, no peer verification). Addresses are numeric IPv4 or IPv6; port
+`--9p-tcp='tcp!127.0.0.1!5640'` adds TCP. Addresses are numeric IPv4 or IPv6; port
0 picks one; #file("/listeners") reads them back. Every connection has full
session access, #file("/os") included, and TCP is unencrypted: use
loopback. Unix and TCP share 16 connection slots; a 17th client's Tversion
gets `too many connections` (and the log
-`err - 9p: too many connections (N turned away)`). QUIC has 16 of its own.
-plan9port and v9fs need a userspace bridge for QUIC.
+`err - 9p: too many connections (N turned away)`).
`$XDG_RUNTIME_DIR/9p` is the machine's `/srv`: servers post themselves
there by name, and `9ns --mntgen` mounts the whole registry. A pardes whose