Kernel developer reading and verification guide¶
This guide uses v4.2.5 as an inspectable implementation baseline. Confirm the issue/version and follow one data path rather than starting with every directory or historical RFC.
Environment and reading order¶
The tag’s go.mod requires Go 1.26.4. C/native dependencies and platforms also matter: use the target BUILD/Makefile and actual output. Record OS/architecture, Go, C compiler, dependencies and build identity rather than reusing old tool versions.
Route |
Source entry points |
Starting document |
|---|---|---|
SQL to result |
Frontend → plan → compile → colexec |
|
Commit/visibility |
txn/client → lockservice → TAE txn → Logtail |
|
Object reads/layout |
DistTAE → ObjectIO → FileService → TAE |
|
Recovery/retention |
Checkpoint → Replay → GC/protection |
|
Control plane |
bootstrap/HAKeeper/ClusterService/Proxy |
Minimal changes and tests¶
Fix one SQL/concurrency schedule, establish failure/correct expectation, then locate data structures and wait/release points. Unit tests establish local behavior; BVT validates client SQL; multi-CN, faults, resources and stability validate cross-component behavior. They are not interchangeable.
Inspect existing tests/environment instructions before changing code. Choose a focused set: terminal resources for cancellation/memory, Merge/GC for history, error/unknown outcomes for commits. Follow actual native prerequisites instead of promising generic go test ./... works everywhere.
Documentation acceptance¶
Mechanism pages need version/status, diagram/timeline, invariants, normal/failure/retry/release paths, fixed source/tests, settings/observations and reproducible experiments. Label proposals as proposed. Report parsing, execution, strict results and fault experiments separately.
Tutorials need fixtures, permissions/topology, steps, expectations and cleanup. Single-node SQL does not establish multi-CN behavior; a setting does not establish spill; NULL does not establish model inference; merged source PRs do not establish formal-branch documentation or publication.
Keep bilingual navigation complete. Main/latest and stable branches build/commit independently; inspect PR base and scope. Content changes do not include CI/theme/generated HTML.
Submission and delivery¶
Use your topic branch and an ordinary push, with issue references, checks and limitations. Do not force-push over another person’s main. Verify source, references, tutorials and deployed pages against their separate versions.