summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-11-05 11:21:15 -0300
committerGabriel Schneider <[email protected]>2026-11-05 12:41:12 -0300
commitcfd2b993feda1b3f7474225bb32db8cac8edc5ae (patch)
tree3248246c043fd1865e74adb979a9cb555f918cd6 /docs
parentc0b2e5d9194ce35b9fbb58d8d6e18de66cb209a8 (diff)
downloadpardes-cfd2b993feda1b3f7474225bb32db8cac8edc5ae.tar.gz
pardes-cfd2b993feda1b3f7474225bb32db8cac8edc5ae.zip
targets: the ESP32-P4 board port goes (src/esp32p4*.zig and src/esp32p4/, -Dplatform=esp32p4 with its pinned riscv32 target, -Desp32p4-cols and -rows, the Peek, Poke, Hexdump and Gpio words and the Board behind them, the board's 9P engine options, the gpio_toggle host slot), and with it every guard and limit only the board needed: terminal_panes and terminal.enabled (ghostty is in every build), memory.limits' board branching (the desktop values stay), MAX_PANES 64 and MAX_COLS 16 fixed, the board's boot buffer and its embedded boot, the pager's and the terminal's emulator-less paths; tests: the board's GPIO, ring and Board ones go, the boot-OOM and transition-grid ones stay under their own names; the perf harness loses the board's fixture, so the Debug baselines of both frontends are recorded again (--only medium --reps 10)
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
Diffstat (limited to 'docs')
-rw-r--r--docs/helix-keys.md2
-rw-r--r--docs/macos.md5
-rw-r--r--docs/selections.md7
-rw-r--r--docs/shared-libs.md4
-rw-r--r--docs/typ/building.typ33
5 files changed, 20 insertions, 31 deletions
diff --git a/docs/helix-keys.md b/docs/helix-keys.md
index 135e1610..16ad856b 100644
--- a/docs/helix-keys.md
+++ b/docs/helix-keys.md
@@ -287,7 +287,7 @@ keeps the matches it found so far.
| an all-lowercase pattern | matches case-blind | helix's smart-case. mvzr has no such flag, so the surface is lowercased instead (ASCII folding is byte-for-byte, so the offsets are identical) | helix-verified |
| `^` and `$` | hold at every line's start and end | helix compiles with `multi_line(true)`; pardes gets the same by searching each line as its own haystack (`src/regexp.zig`) | helix-verified |
| `.` | never matches a newline | as the Rust regex crate: a pattern without `\n` searches line by line, and one that names `\n` has its `.`s made `[^\n]` (`src/regexp.zig`) | helix-verified |
-| many matches | up to `memory.limits.selections` ranges: 1024 on the desktop, 64 on the board; matches past it are dropped | helix has no limit. The room for them is allocated when a second range appears and given back at one range, so a single cursor costs nothing | helix-verified up to the limit |
+| many matches | up to `memory.limits.selections` ranges, 1024; matches past it are dropped | helix has no limit. The room for them is allocated when a second range appears and given back at one range, so a single cursor costs nothing | helix-verified up to the limit |
| `K<pat>` / `Alt-K<pat>` Enter | keep only the ranges a match starts inside / only those none does; primary 0, and keeping none leaves the selection alone | helix `keep_selections` / `remove_selections`, on the same prompt as `s`/`S` (markers `Keep /`, `Remove /`). The range is searched as `s` searches it, line by line with its lines' context, where helix matches the range's text alone: a `^` right at a range that starts mid-line matches in helix and not here | helix-verified |
### `Ctrl-c` — toggle comments
diff --git a/docs/macos.md b/docs/macos.md
index e389ba66..5542ac14 100644
--- a/docs/macos.md
+++ b/docs/macos.md
@@ -826,9 +826,8 @@ relative to `zig-out` unless you pass `--prefix` yourself. The `<prefix>/dev`
directory the benchmark binaries install into likewise never appears in this
backend; nothing here is a dev binary.
-`-Dplatform=macos` is one of the two platforms that override the repo's default
-target; `esp32p4` is the other, and pins its own riscv32-freestanding query.
-The tty, SDL and web shells default to the Steam Deck (x86_64 linux-gnu, glibc
+`-Dplatform=macos` is the one platform that overrides the repo's default
+target. The tty, SDL and web shells default to the Steam Deck (x86_64 linux-gnu, glibc
pinned to 2.38), and that default is not survivable here: swiftc links this
archive, so a Steam Deck build hands ld64 ELF objects inside a GNU archive and
the app link dies with `archive member '/SYM64/' not a mach-o file`. On a Mac
diff --git a/docs/selections.md b/docs/selections.md
index ee796cde..f1d899a8 100644
--- a/docs/selections.md
+++ b/docs/selections.md
@@ -10,8 +10,7 @@ at `694e7dfdd`, upstream `278b24389`.
Every `Text` (src/Text.zig) has its own: a pane's body, its tag, a prompt's
answer, a column's or the workspace's tag. A selection is one primary range
-plus others, up to `memory.limits.selections` in all (1024 on the
-desktop, 64 on the board).
+plus others, up to `memory.limits.selections` in all (1024).
- The PRIMARY is where the cursor always was: `cur_row`/`cur_col` is the
head, `vsel.row`/`vsel.col` the anchor while `vsel.active`, and a bare
@@ -113,8 +112,8 @@ the replay.
- Direction of a one-character range: both of its cells are the same cell,
so it has none. helix can flip one (`Alt-;`) and the commands that read
the head (`&`, the next extend) see the difference.
-- Count: at most `memory.limits.selections` ranges (1024 on the desktop, 64
- on the board); matches past that are dropped silently.
+- Count: at most `memory.limits.selections` ranges (1024); matches past that
+ are dropped silently.
- `n`/`N` walk the look ring (acme), not regex search hits, and there is no
`*`; helix-golf's `*`, `""N` and `n` do not apply.
- `s`/`S` match as sam does (docs/helix-keys.md, "Regex selection"): each
diff --git a/docs/shared-libs.md b/docs/shared-libs.md
index 0a78f207..412c2474 100644
--- a/docs/shared-libs.md
+++ b/docs/shared-libs.md
@@ -59,7 +59,7 @@ Text section: tty 61,369,343 → 61,294,855 bytes (**−74,488**); gui
- **PNG and JPEG are wuffs's**, the decoders ghostty itself uses. image.zig
calls them wherever ghostty-vt is in the build (`wuffs_images`). Each image
is sized from its header first: PNG's IHDR, JPEG's first SOF. Other formats,
- and builds without ghostty-vt (esp32p4, web), stay on stb_image.
+ and builds without ghostty-vt (web), stay on stb_image.
- **zstbi is compiled with `-DSTBI_NO_PNG -DSTBI_NO_JPEG`.** That also drops
stb's inflate, which only PNG used. Its `stb_image_write` include is patched
out (one count-checked anchor), with a no-op `stbi_flip_vertically_on_write`
@@ -81,7 +81,7 @@ Text section: tty 61,369,343 → 61,294,855 bytes (**−74,488**); gui
- **Two JPEG decoders: MuPDF's libjpeg and wuffs.** MuPDF's `DCTDecode` filter
(`filter-dct.c`) is written against libjpeg's streaming source-manager API.
Moving PDFs onto wuffs means a new DCT filter for fitz. Moving image panes
- onto libjpeg instead would leave the builds without MuPDF (esp32p4, web)
+ onto libjpeg instead would leave the build without MuPDF (web)
with no JPEG decoder.
- **MuPDF's fitz image loaders** (`fz_load_png`, `_jpeg`, `_gif`, `_bmp`,
`_tiff`, `_pnm`, `_psd`; 16.7 KiB together). They are compiled because
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index b4d7cb82..da704fe8 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -20,7 +20,6 @@ builds MuPDF and is on by default (`-Dmupdf=false` drops it).
[`zig build -Dplatform=gui`], [the SDL3 window alone],
[`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],
)
A bare `zig build` installs into the prefix (`zig-out`, or `--prefix
@@ -33,26 +32,20 @@ without installing. `pardes --version` prints `pardes <version>` (from
install, and on a second line the build's semantics hash, which a replica
must share with its session; `pardes --help` lists every flag.
-The ESP32-P4 firmware is linked in the sibling `../05-zig-p4` toolchain,
-which needs ESP-IDF register headers: after building the editor object
-here, `zig build -Dpardes` there links `src/esp32p4/app.zig`. The separate
-GPIO 9P image is `zig build -Dapp=../02-pardes-code/src/esp32p4_9p.zig`
-there; its namespace is in `src/esp32p4_gpio.zig`.
-
== Build options
`zig build --help` lists the options for the selected platform.
#pairs(
- [`-Dplatform`], [`tui`, `gui`, `web`, `macos`, `esp32p4`; absent: the tui and SDL shells together, installed into `~/.local`],
+ [`-Dplatform`], [`tui`, `gui`, `web`, `macos`; absent: the tui and SDL shells together, installed into `~/.local`],
[`-Dstatic`], [bool, `false`],
- [`-Dmupdf`], [bool; on natively, off for web and esp32p4],
+ [`-Dmupdf`], [bool; on natively, off for web],
[`-Djpx`], [bool, `true`: JPEG 2000, and with it scanned PDFs],
- [`-Dtree-sitter`], [`disabled`, `zig`, `minimal`, `full`; `full` natively, `zig` for web, `disabled` for esp32p4],
+ [`-Dtree-sitter`], [`disabled`, `zig`, `minimal`, `full`; `full` natively, `zig` for web],
[`-Dembed-sources`], [bool, `false`: serve the sources under #file("/src")],
[`-Dhome-install`], [bool: a bare `zig build` also copies the binaries into `~/.local/bin`; default true],
[`-Dstamp-commit`], [bool: the git commit in `--version` and crash records; on for release builds and the `~/.local` install],
- [`-Dtheme-animation`], [bool; on except for esp32p4],
+ [`-Dtheme-animation`], [bool, `true`],
[`-Dworkspace-tag`], [bool: draw the workspace tag row; on except for macOS, whose menu bar carries it],
[`-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],
@@ -61,7 +54,6 @@ 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 ESP32-P4's grid, 56 by 14],
)
= Tests
@@ -142,7 +134,7 @@ Mail patches to the list `~gbrls/[email protected]`; it is the preferred way to
= The core and its shells
-One core, five shells (tui, gui, web, macos, esp32p4). The core owns
+One core, four shells (tui, gui, web, macos). The core owns
editing, layout, rendering and the virtual filesystem it serves over 9P; a shell turns native
input into `pardes.Event`, presents `pardes.Surface`, and performs host
effects such as spawning processes.
@@ -163,13 +155,13 @@ effects such as spawning processes.
- `host_io.Host` is a context pointer and a vtable of optional callbacks; a
null method is not an error, and `Host{}` is a complete in-process pardes
that the tests use. Comptime decides what a build has (`pardes.platform`,
- `hosted`, `can_attach`, `terminal_panes`, `pdf_enabled`); the vtable
+ `hosted`, `can_attach`, `pdf_enabled`); the vtable
decides who serves it.
- The root module is chosen by platform: `main.zig` (tui, gui),
- `web.zig`, `macos.zig`, `esp32p4.zig`. The web and macOS shells are
+ `web.zig`, `macos.zig`. The web and macOS shells are
libraries whose host owns `main()`.
-- `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
+- `memory.limits` is the one home for the core's capacities (selections,
+ the tag's bytes, undo, the arenas' regions). Each core
allocator is a thread-safe stack-fallback allocator, under a
DebugAllocator in Debug builds.
@@ -196,7 +188,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 ESP32-P4, the browser) has no second thread.
+`turn.start` (the tests, the browser) has no second thread.
== The daemon and detached sessions
@@ -264,9 +256,8 @@ shared code.
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 ESP32-P4's engine settings: msize
- 65536, 256 fids, 128 held reads a connection, names up to 255 bytes; the
- ESP32-P4 has 32 fids.
+ `src/9p.zig` names the editor's engine settings: msize 65536, 256 fids,
+ 128 held reads a connection, names up to 255 bytes.
- 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.