From b48f79a1c19c4c96c30d29d5f8ac5ad19c8e3475 Mon Sep 17 00:00:00 2001 From: Gabriel Schneider Date: Thu, 5 Nov 2026 15:40:52 -0300 Subject: docs: the state file and the dumps as they are now: the reference's Dump and Restore paragraph (a label, `/dumps`, `Dump export ` to carry one, Restore of a label or a path, the words for a label the file keeps none of), its DumpDir row (the state file's directory, one that cannot be read kept aside), `/recent` kept in the state file, `/dumps` among the root files, the snapshots and the stats, and the log's `dump` and `restore` records; building.typ's Upgrade (`upgrade-` in the state file, the build before's `.dump` still read); setup.typ's new list of the files pardes keeps (the startup file and the crash record, the state file, the blob cache, the runtime directory's, and the build before's to delete); next-store.md's decision (everything on disk through xitdb, with the measured costs) over W4's, the closed panes under it and its tests as they are; and the changelog's entry, what a user must know: labels where dump files were, `Dump export`, `.dump` files read for one release, Recent read once from its old file, DumpDir now the state file's directory, the old cache directory no longer read, an unreadable state file kept aside Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge --- docs/typ/building.typ | 3 ++- docs/typ/reference.typ | 43 +++++++++++++++++++++++++++++-------------- docs/typ/setup.typ | 19 +++++++++++++++++++ 3 files changed, 50 insertions(+), 15 deletions(-) (limited to 'docs/typ') diff --git a/docs/typ/building.typ b/docs/typ/building.typ index 456cbb3e..4b736251 100644 --- a/docs/typ/building.typ +++ b/docs/typ/building.typ @@ -224,7 +224,8 @@ pings and nothing more. #word("Upgrade") (`src/upgrade.zig`) execs the path the session was started from, at a step boundary, after asking it `--version`: the session's dump -goes to the DumpDir (`pardes-upgrade-.dump`), and its pty masters, +is committed to the state file as `upgrade-` (the build before wrote +`pardes-upgrade-.dump`, which this one still reads, for one release), and its pty masters, terminals, stubs and daemon link stay open across the exec, named in a record on the new command line (`--upgraded=`) ahead of the arguments it was started with. The pid stays, so the shells stay its children; the new diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ index d0f492cf..cb2df2a8 100644 --- a/docs/typ/reference.typ +++ b/docs/typ/reference.typ @@ -160,7 +160,7 @@ the next read on that fid is EOF until the next write (or seek to 0). With other clients about, write and read on one open: #cmd("exec 3<>$m/pane/$n/look; echo x >&3; cat <&3; exec 3<&-") -*Snapshots.* #file("/index"), #file("/layout"), #file("/recent"), +*Snapshots.* #file("/index"), #file("/layout"), #file("/recent"), #file("/dumps"), #file("/commands"), #file("/status"), #file("/listeners"), #file("/sessions"), a read-only #file("ctl"), #file("/log"), #file("/screen") and a terminal's #file("body") freeze at the open, so one read in several chunks never @@ -192,7 +192,7 @@ the range and flag files, the workspace's #file("tag"), the root #file("look")/#file("exec") answers, #file("focus"); #file("event") and #file("pty/data") the next record's, zero when none waits. A stream and a view generated by each read stat 0, as acme's do: #file("log"), #file("screen"), #file("data"), #file("xdata"), #file("index"), -#file("layout"), #file("recent"), #file("listeners"), #file("sessions"), #file("pane/new"). +#file("layout"), #file("recent"), #file("dumps"), #file("listeners"), #file("sessions"), #file("pane/new"). Read those to the end rather than trust a length (`cat` does). The qid version of #file("body"), #file("data") and #file("xdata") is the pane's revision, so a stat sees an edit land. Modes are 0644/0666, 0444 @@ -389,20 +389,30 @@ Writes take settings and session builtins (`scope = .session` in #word("Delcol") and a pane's `get` refuse the same way with their own word, except that #word("Delcol") opens no `+Unsaved` pane: it names the panes only in its `unsaved` records and its notice. -- #word("Dump") writes `pardes--