Skip to content

docs: name the klib API dump in AGENTS.md #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesarich merged 1 commit into from
Oct 3, 2026
Merged

docs: name the klib API dump in AGENTS.md #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ would be over-engineering here.
(`ZSTD_WINDOWLOG_LIMIT_DEFAULT` = windowLog 27), so `encode()` rejects it
with a `ZstdException` up front rather than emit a frame most real-world
libzstd consumers refuse. Keep this guard — it's what "frames stay
libzstd-interoperable in both directions" actually requires now that
multi-block encoding has no other size limit.
libzstd-interoperable in both directions" requires, because multi-block
encoding has no other size limit.
- **No shared mutable state, no lock.** A `ZstdDictionary` digests its dictionary
once in its constructor and is immutable thereafter; the engine objects keep all
per-call state in locals. Do not reintroduce global caches. The encoder's
Expand All @@ -60,8 +60,10 @@ would be over-engineering here.
- **`maxSize` is a required decompression-bomb guard** on every decode.
- **The public API throws only `ZstdException`** (annotated `@Throws` so it bridges
to Swift / Kotlin-Native callers instead of aborting the process).
- **`explicitApi()` + binary-compatibility-validator:** run `./gradlew apiDump`
after any public-API change and commit `api/kzstd.api`.
- **`explicitApi()` + binary-compatibility-validator with the klib dump:** run
`./gradlew apiDump` on macOS after any public-API change and commit both
`api/kzstd.api` and `api/kzstd.klib.api`. Elsewhere the Apple targets are kept
from the committed dump, not regenerated.
- **Frames stay libzstd-interoperable in both directions** — guarded by the
`jvmTest` zstd-jni oracle and the pinned cross-target dict-entropy fixture.

Expand Down
Loading