docs(readme): systematic refresh — v0.10 reality + drop stale migration + 2026-06-25 bench#143
Merged
Merged
Conversation
v0.7 把 Go 引擎搬进 pine-go/ 子目录 + row_dependency→consumes_row_set + barrier→marker interface + Field Accessor 三态翻转,这些破坏性变更 到 v0.10 已经过去 3 个 minor + 14 个 patch 版本,生产用户都早已迁移 完成。继续放在 README 主线只会让首屏被 80 行历史变更挡住,新读者 找不到核心特性。 迁移指南本身没失效,但归档价值已耗尽——查 git log / CHANGELOG.md 或 design_doc 即可。design_doc 仍持有完整的语义描述(05_operator_ types.md 的 consumes_row_set DSL 字段、04_operator_registration.md 的注册形态、03_xxx 的 DAG 调度模型),不构成知识丢失。
…fan-out Core features list was last refreshed pre-v0.10; this batch syncs to v0.10.9 reality: - Lua: explicit pine-go default = wangshu (with build-tag escape to gopher-lua), pine-java = LuaJC, pine-cpp = LuaJIT. The default flip landed in v0.10 series. - Resources: split into data-typed (snapshot) vs handle-typed (borrow + RAII teardown) — `redis_connection` is the canonical handle-typed resource. The old one-liner "background-refreshed in-memory resource manager" hides the architecture. - Redis: add dedicated bullet for the 5 cascade-safety params and the 4-state per-command metrics + fail-on-error contract. These shipped in #137 and are production-load-bearing. - Observability: /stats is no longer just a single endpoint — call out /stats.http and /stats.resources sub-trees so readers can find the resource fan-out and HTTP middleware metrics. - Cross-validation bullet: name the actual verification surface (19 cross-validate sections + differential fuzz + daily sanitized fuzz) instead of the vague "verified for schema/DAG/exec/error parity". EN side kept structurally aligned with the CN edits.
… CI row
The README has grown out of sync with how dev work actually happens now.
Three additions:
1. **Makefile section** at the top of the dev block. The top-level
Makefile + pine-go/Makefile are the actual unified entry — CI and
local share the exact verb sequence. Up to now scripts/ was the only
surface readers saw, which understates the project's task plumbing.
Cross-checked the listed verbs against `make` output: all exist.
2. **Local Git Hooks section**. .githooks/{pre-commit,pre-push} ships
in-tree and is the source of three concrete dev ergonomics:
staged-only format gate (no surprise overwrites), four-language lint
on push, and the auto `--set-upstream` relay landed in pine #139
(absorbed from wangshu#24 / ctex-kit#888). Without docs, first-time
contributors miss `core.hooksPath` and lose the lint gate.
3. **Daily sanitized fuzz** added to the CI list — promoted from weekly
to daily in ef24382 (#109) and load-bearing for race / memory-bug
surveillance separate from the per-push fuzz fast lane.
Also added `llmdoc/` to the Documentation table since it is now the
canonical AI-collaboration knowledge map and constantly referenced from
issue comments. clang-format -Werror clarified as the actual C++ lint
form (the bare "-Werror" was ambiguous).
EN side kept structurally aligned.
Re-ran the full 14-fixture cross-runtime bench on the standard 2C/4G cgroup (10000 req × 16 conc) on the same machine that produced the previous 2026-06-11 numbers. v0.10 series picked up wangshu CallInto / GlobalsSlot fast paths, outputPool (#119), and Redis cascade-safety (#137) — re-baseline so the README reflects measured reality. Changes worth calling out: - Three calibrated fixtures now listed instead of one. Until now the README collapsed the calibrated family to a single row, hiding the itemlua variant entirely. itemlua (3000 Lua calls/request) is the boundary-dominated workload that anchors the perf-evolution-roadmap "calibration fact 2 — end-to-end dilution" finding; it deserves to show up. - C++ headline lift: 1.8x → 1.9x against Go/Java on calibrated. P50 60.8ms vs 117/122ms is the more legible framing than the QPS ratio. - Synthetic small/medium movements are all within ±10 % run-to-run noise; the relative shape (Go highest at small, Java reverses on large_1000+) is unchanged. - Reproduce command now lists `make bench-cross-runtime` first. Source data: bench-results/report-20260625-090834.txt
Contributor
🔍 PR 审查
纯文档刷新,对 README v0.10 现状的逐项核对全部通过——所列设施与代码库一致,benchmark 数字 EN/CN 双语同步无偏差。
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.md / README-en.md 上一次系统刷新是 2026-06-09(
82c1ef1b),自那以来主干合入了 ~100 个 commit,涵盖 wangshu 默认翻转、Redis cascade-safety、/statsfan-out 分子树、PR #139 自动-u接力、daily sanitized fuzz、v0.10 系列 perf 优化等多个生产关键变化。本 PR 把双语 README 系统性对齐到 v0.10.9 的实际状态。Commit 拆分(单 PR 多 commit,单域隔离)
b4bc0c56删 v0.7 迁移段(-167 行)pine-go/+row_dependency→consumes_row_set+ barrier→marker + Field Accessor 三态翻转,到 v0.10 已经 3 个 minor + 14 个 patch 版本,生产用户都迁移完了a0bc690c核心特性同步 v0.10-tags=lua_gopher切 gopher-lua)、pine-java LuaJC、pine-cpp LuaJIT/stats.http+/stats.resources子树d22b1de9工程基础设施新章节make输出 cross-check 过--set-upstream(PR feat(githook): pre-push auto --set-upstream relay — absorb wangshu#24 #139 落地)llmdoc/入口,作为 AI 协作的稳定知识地图59fc37ffBenchmark 表 2026-06-25 重测llmdoc/memory/decisions/perf-evolution-roadmap.md的"calibration fact 2 — end-to-end dilution"bench-results/report-20260625-090834.txt双语对齐
CN/EN 双侧逐 commit 保持结构对齐。验证:
makeverb 表 13 行全部 cross-check 过make输出存在ls验证存在(双语)Test plan