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.typ15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index 31019116..6bf7dfce 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -41,8 +41,10 @@ system takes the SDK SDL needs with `-Dmacos-sdk=<path>`.
A bare `zig build` installs into the prefix (`zig-out`, or `--prefix
<dir>`) and copies the binaries into `~/.local/bin`; `-Dhome-install=false`
leaves that copy out. Zig 0.17 keeps the prefix from the build script, so
-`--prefix` alone no longer stops it. With `-Dplatform` nothing is copied,
-so always pass `-Dplatform` while developing. Test, benchmark and run steps build what they need
+`--prefix` alone no longer stops it. With `-Dplatform` binaries are not copied. The `image`, `pdf` and
+`addons` steps also install into `$XDG_DATA_HOME/pardes/addons` (else
+`~/.local/share/pardes/addons`); `-Dhome-install=false` skips that copy.
+Pass `-Dplatform` and `-Dhome-install=false` while developing. Test, benchmark and run steps build what they need
without installing. `pardes --version` prints `pardes <version>` (from
`build.zig.zon`), plus the commit for release builds and the `~/.local`
install, and on a second line the build's semantics hash, which a replica
@@ -183,6 +185,15 @@ zig build cheatsheet render the cheatsheet PDF (needs typst)
- `python3 -B test/agent_session.py <pardes> --ready 'text' --min-rows N -- command args` drives an interactive command in a private shell and checks
it through 9P.
+The optional real-server check
+`python3 -B test/real_zls.py GUI_BINARY ZLS_BINARY OUTPUT_DIRECTORY`
+uses a private home and a restricted desktop `PATH`. It checks a build-module
+import as the first query without retries, standard and relative imports,
+paths with spaces, imported symbols,
+hover, references, rename previews, diagnostics and completion while editing.
+It requires Zig and ZLS; `core-test -Dtest-filter=lsp_client` checks the
+protocol client's own tests without installed language servers.
+
== Release gates
A release passes all of these first: `unit-test` with `-Dplatform=tui` and