Skip to content

docs: correct stale "not a server knob" claim in turbo-kv-cache.md - #1571

Merged
inureyes merged 3 commits into
mainfrom
fix/issue-1139-stale-server-knob-claim
Sep 2, 2026
Merged

inureyes merged 3 commits into
mainfrom
fix/issue-1139-stale-server-knob-claim

Conversation

@inureyes

@inureyes inureyes commented Sep 2, 2026

Copy link
Copy Markdown
Member

Summary

docs/turbo-kv-cache.md still described MLXCEL_PAGED_ATTENTION_NATIVE as a library/bench-only control, "not a server knob." That claim went stale when issue #899 made the fused v2 kernel the production decode path and turned this variable's force-off values into the server's kill switch, and the same claim was already corrected in docs/environment-variables.md by PR #1119.

What changed

Test plan

  • grep -rn "not a server" docs README.md only shows the ADR 0001 decision record and the two History: clauses (in docs/environment-variables.md and now docs/turbo-kv-cache.md), none asserting current behavior
  • python3 scripts/ci/check_cross_repo_refs.py passes
  • git diff --stat shows docs/turbo-kv-cache.md only, no code touched

Closes #1139

MLXCEL_PAGED_ATTENTION_NATIVE gained a second, server-side consumer in issue #899 (resolve_paged_v2_dispatch in src/lib/mlxcel-core/src/layers.rs), which made the fused v2 kernel the production decode path and turned this variable's force-off values into its kill switch. docs/turbo-kv-cache.md still described it as library/bench-only, the same stale claim PR #1119 already corrected in docs/environment-variables.md.

The rewritten paragraph names both consumers (the library-only pooled entry point retired by #710, and the server's pool-backed batched paged decode), states the #899 kill-switch and force-on behavior, keeps the #710 retirement as history rather than a current statement, and cross-links docs/environment-variables.md and docs/CONTINUOUS_BATCHING.md instead of duplicating the dispatch policy and log-line prose. The ADR 0001 link is unchanged, and docs/adr/0001-paged-attention-gather-vs-fused-kernel.md and the History clause in docs/environment-variables.md are left untouched since both intentionally describe the past.
@inureyes inureyes added type:docs Documentation improvements or additions priority:medium Medium priority status:review Under review labels Sep 2, 2026
@inureyes inureyes added status:done Completed and removed status:review Under review labels Sep 2, 2026
@inureyes
inureyes merged commit 02f0d7f into main Sep 2, 2026
13 checks passed
@inureyes
inureyes deleted the fix/issue-1139-stale-server-knob-claim branch September 2, 2026 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Medium priority status:done Completed type:docs Documentation improvements or additions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Correct the stale "not a server knob" claim in docs/turbo-kv-cache.md

1 participant