summaryrefslogtreecommitdiff
path: root/docs/typ/building.typ
diff options
context:
space:
mode:
Diffstat (limited to 'docs/typ/building.typ')
-rw-r--r--docs/typ/building.typ16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index 4b736251..50b85986 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -12,7 +12,9 @@ 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).
+is an addon, `pdf.so`, built over MuPDF (its own FreeType and zlib in it)
+and on by default (`-Dmupdf=false` leaves it out); the binaries hold no
+MuPDF.
#pairs(
[`zig build`], [the terminal shell and the SDL window together, *installed into `~/.local/bin`* (`pardes` and `pardes-gui`)],
@@ -38,7 +40,7 @@ must share with its session; `pardes --help` lists every flag.
#pairs(
[`-Dplatform`], [`tui`, `gui`, `macos`; absent: the tui and SDL shells together, installed into `~/.local`],
[`-Dstatic`], [bool, `false`],
- [`-Dmupdf`], [bool, `true`],
+ [`-Dmupdf`], [bool, `true`: build and install the PDF addon],
[`-Djpx`], [bool, `true`: JPEG 2000, and with it scanned PDFs],
[`-Dtree-sitter`], [`disabled`, `zig`, `minimal`, `full`; `full`],
[`-Dembed-sources`], [bool, `false`: serve the sources under #file("/src")],
@@ -60,7 +62,7 @@ must share with its session; `pardes --help` lists every flag.
zig build unit-test module and shell unit tests (the perf gate runs with it)
zig build test-build compile the unit-test programs without running them
zig build core-test core tests without native shell tests
-zig build pane-test pane, output, PDF and namespace integration tests
+zig build pane-test pane, output and namespace integration tests
zig build kitty-test kitty graphics conformance of terminal panes, at the core
zig build kitty-harness kitty graphics through a pane end to end (a fake kitty
terminal outside on the tui, the GPU capture on the gui;
@@ -81,7 +83,7 @@ zig build hxdiff differential suite against helix's own behaviour
zig build hxparity file-pane vs pty-pane editing parity
zig build hxgolf every helix-golf example, step by step, against helix
zig build perf-gate a gesture on the 50k-line file over 3x its baseline fails
-zig build mupdf-check compile, link, render and search docs/design.pdf
+zig build mupdf-check the PDF addon's MuPDF: compile, link, render and search docs/design.pdf
zig build cheatsheet render the cheatsheet PDF (needs typst)
```
@@ -103,8 +105,8 @@ zig build cheatsheet render the cheatsheet PDF (needs typst)
- `zig build hxdiff -- --strict cases.jsonl reference.jsonl [waivers.jsonl]` runs custom differential cases. `docs/helix-keys.md`
tracks helix parity key by key and names the reference helix build;
`docs/selections.md` is the selection model under normal mode.
-- Benchmarks (`perf`, `pdf-bench`, `pdf-scroll-bench`,
- `pdf-sections-bench`, `lspbench`, `fs-bench`) take `-- --json`; measure
+- Benchmarks (`perf`, `pdf-scroll-bench`, `pdf-pointer-bench`,
+ `lspbench`, `fs-bench`) take `-- --json`; measure
with `-Doptimize=ReleaseFast`. `perf -- --base old.json` refuses reports
whose build metadata differs.
- `zig build history -- run 'ancestors(@, 2)' DIR -- zig build unit-test`
@@ -151,7 +153,7 @@ 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`,
- `can_attach`, `pdf_enabled`); the vtable
+ `can_attach`); the vtable
decides who serves it.
- The root module is chosen by platform: `main.zig` (tui, gui),
`macos.zig`. The macOS shell is a library whose host owns `main()`.