Skip to content

docs: record experimental-tier exclusion (CCtxParams) in binding scope#37

Merged
dfa1 merged 1 commit into
mainfrom
docs/cctxparams-scope
Jun 27, 2026
Merged

docs: record experimental-tier exclusion (CCtxParams) in binding scope#37
dfa1 merged 1 commit into
mainfrom
docs/cctxparams-scope

Conversation

@dfa1

@dfa1 dfa1 commented Jun 27, 2026

Copy link
Copy Markdown
Owner

What

Documents why the ZSTD_CCtx_params bundle is intentionally not bound.

The CCtxParams cluster (ZSTD_createCCtxParams, ZSTD_CCtxParams_setParameter, ZSTD_CCtx_setParametersUsingCCtxParams, …) is ZSTDLIB_STATIC_API — experimental tier:

  • gated behind ZSTD_STATIC_LINKING_ONLY, no stability guarantee
  • not guaranteed to survive the -fvisibility=hidden export table
  • only saves a few setParameter calls at context init (never a hot path)
  • the bound per-context ZSTD_CCtx_setParameter path covers the same need

Changes

  • adr/0013 — extend the binding-scope decision to exclude the experimental tier; name the CCtxParams cluster and the rationale so it is not rediscovered cold
  • docs/supported.md — note the reason on the Advanced parameters row (the bare rows now have a "why"), linked to ADR 0013

Docs only — no code, no API change.

🤖 Generated with Claude Code

@dfa1 dfa1 force-pushed the docs/cctxparams-scope branch 2 times, most recently from 0b0146a to 62aafbc Compare June 27, 2026 18:08
The ZSTD_CCtx_params bundle is ZSTDLIB_STATIC_API — experimental tier.
The symbols are exported (the macro resolves to visibility("default"),
so the FFM layer could bind them by name), but they carry no API-stability
guarantee and may change or be removed between zstd releases. The bundle
only saves a few setParameter calls at context init, and the stable
per-context ZSTD_CCtx_setParameter path (already bound) covers the same
need, so it is intentionally not bound. Extend ADR 0013 to exclude the
experimental tier and note the reason on the supported.md Advanced
parameters row.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@dfa1 dfa1 force-pushed the docs/cctxparams-scope branch from 62aafbc to a3fca47 Compare June 27, 2026 18:10
@dfa1 dfa1 merged commit 89c6d63 into main Jun 27, 2026
1 check passed
@dfa1 dfa1 deleted the docs/cctxparams-scope branch June 27, 2026 18:11
dfa1 added a commit that referenced this pull request Jun 27, 2026
Two project subagents under .claude/agents/, both pinned to Opus 4.8:

- zstd-coder: implements changes against the project's FFM/segment-first
  conventions, runs ./mvnw validate before claiming done.
- zstd-reviewer: read-only diff review focused on FFM memory safety,
  native sentinel handling, the zero-copy contract, test coverage, and
  the build gates (checkstyle, javadoc).

Used as a coder -> reviewer loop; the reviewer already caught a factual
error in #37 before merge. settings.local.json stays gitignored.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant