summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-29 17:01:35 -0300
committerGabriel Schneider <[email protected]>2026-10-29 21:13:33 -0300
commit70de5ec5ff3dad01afcc45244ad5e5a481486da6 (patch)
treecd4b723dcc2cfd94c4ba2361c134927b0e2df60b /docs
parent349790339897466f323ff28748916aa48aa344f7 (diff)
downloadpardes-70de5ec5ff3dad01afcc45244ad5e5a481486da6.tar.gz
pardes-70de5ec5ff3dad01afcc45244ad5e5a481486da6.zip
dump: one walker dump of the whole session, by name across builds, for Restore, -l, Handover and the store; dump.zig's hand-written schema gone
A dump is walk.zig's walk of the core with a table of every type it reaches (fields, enum and union names, number widths), read back by name; terminals are ghostty's snapshot (screens, history, kitty images); a failed load frees what it made. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r--docs/typ/building.typ4
-rw-r--r--docs/typ/reference.typ35
2 files changed, 20 insertions, 19 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index 00088d7b..e42702c6 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -19,7 +19,7 @@ builds MuPDF and is on by default (`-Dmupdf=false` drops it). 9P over QUIC
[`zig build`], [the terminal shell and the SDL window together, *installed into `~/.local/bin`* (`pardes`, `pardes-gui`, and `pardes-v9fs`, the #word("Tty9p") helper)],
[`zig build -Dplatform=tty`], [the terminal shell alone],
[`zig build -Dplatform=gui`], [the SDL3 window alone],
- [`zig build web -Dplatform=web -Dtarget=wasm32-freestanding -Ddump=<dump.zon>`], [a freestanding wasm core plus vanilla JavaScript (`docs/web.md`)],
+ [`zig build web -Dplatform=web -Dtarget=wasm32-freestanding -Ddump=<file>`], [a freestanding wasm core plus vanilla JavaScript (`docs/web.md`)],
[`zig build -Dplatform=macos`], [an AppKit and CoreText app over a static `libpardes.a` (`docs/macos.md`)],
[`zig build -Dplatform=esp32p4`], [a freestanding riscv32 editor object for the ESP32-P4, with a 384 KiB heap],
)
@@ -59,7 +59,7 @@ there; its namespace is in `src/esp32p4_gpio.zig`.
[`-Dprebuilt-shaders`], [bool: embed the committed SPIR-V; on for a bare `zig build`, off with `-Dplatform`; `zig build shaders` refreshes it with glslc],
[`-Dtracy`], [path to a Tracy checkout; off],
[`-Dmacos-identity`], [codesigning identity for `pardes.app`; `-` (ad hoc)],
- [`-Ddump`], [a `dump.zon` to embed in the web shell],
+ [`-Ddump`], [a Dump to embed in the web shell],
[`-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`],
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index ce2a45f1..2e395cc6 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -368,22 +368,20 @@ 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-<date>-<time>.zon` (UTC) in #word("DumpDir"),
+- #word("Dump") writes `pardes-<date>-<time>.dump` (UTC) in #word("DumpDir"),
logs `dump <path>`, and adds a #word("Restore") `<path>` word naming it to the
workspace tag (the last dump's, replacing an earlier one's).
#word("Restore") `[path]` replaces every pane (bare: the last dump this session
wrote). The #word("Restore") write is answered, then *every connection is hung
up*: dial again, and restart a 9ns mount. The new log has a `new` per
- pane, `restore <path>`, then `restored <old> <new>` per pane and
- `restoredcol <old> <new>` per column. A dump keeps an unsaved pane's
- text and the hash of the file it was read against; a clean file pane's
- text is read from disk at #word("Restore"), so a file changed since comes back as
- it is now. An unsaved one whose file changed comes back with its own
- text, marked changed on disk, and its first #word("Save") asks before
- overwriting. A PDF's fit and tint are kept too. A #word("Restore") that fails says why in
- the parser's words, a ZON error with its line (`line 3: expected ','`),
- so the errno a mount gives depends on them (usually EIO): read the `err`
- record for why. A #word("ThemeFile") the dump names that fails to load changes
+ pane, then `restore <path>`. Its panes and columns keep the serials they
+ had when dumped; one made after takes a serial past every one the old
+ session handed out. A dump keeps every pane's text and undo: a clean
+ file changed on disk since comes back as it is now, an unsaved one with
+ its own text, marked changed on disk, and its first #word("Save") asks
+ before overwriting. A #word("Restore") of a file that is no dump fails
+ before anything is replaced (`not a pardes dump: it is cut short`), with
+ EIO: read the `err` record for why. A #word("ThemeFile") the dump names that fails to load changes
nothing.
- #word("Kill") `[word...]` (above), #word("Mount") `name dial`, #word("Unmount") `name`, #word("Theme") `x`.
- `size C R` sizes a session no terminal or window is attached to (160x50
@@ -890,7 +888,6 @@ just before the #word("Restore") are not lost.
[`changed <serial> [reloaded|deleted]`], [its file changed on disk (bare: under unsaved edits)],
[`unsaved <serial> <name>`], [a pane an #word("Exit"), #word("Restore"), #word("Del") or #word("Delcol") refused over, before the `err`],
[`dump <path>`, `restore <path>`], [a #word("Dump") written; a #word("Restore"), after its panes' `new`s],
- [`restored <old> <new>`, `restoredcol <old> <new>`], [serial maps after a #word("Restore")],
)
The serial is the pane the line ran at (the pane with the keyboard for the root's
@@ -1032,11 +1029,15 @@ to its end before the write is answered, and one that finds nothing fails,
setting only the other frontend has (#word("Font") in a terminal) is skipped;
text that is no builtin is not run; saving the init file in a pane
applies its settings again and says a bad line as startup does
- (`err - init file line N: why`), its commands not run again. A dump keeps panes, columns, tags,
- selections, the theme and changed settings, but not a picture or a PDF
- that is on disk (#word("Restore") reads it from there); a terminal
- comes back with its last MiB of output and a new shell in its old
- directory; undo history and REPL bindings are not kept. A crash appends
+ (`err - init file line N: why`), its commands not run again. A dump keeps the whole
+ session: panes with their text, undo, selections and places, terminals
+ with their screens, history and kitty images, pictures, registers,
+ columns, tags, the theme and settings. A terminal comes back with a new
+ shell in its old directory under its history (not the REPL it ran), a
+ PDF read from its file.
+ A dump made by another build loads: a field added since takes its
+ default, and what cannot be read (a pane whose kind changed) is left out
+ and said in a notice. A crash appends
two lines (build, time, platform, pid; the panic message) to `crashes`
beside `init`.