TWOBUFQUEUE · 文档

Release source copy / 发布源码副本

本页目录

English · 简体中文

两种格式的源码包都包含 en/ 英文阅读目录和 zh_cn/ 中文阅读目录,打开 START_HERE.html 即可选择语言。源码、页面资源和测试数据共用一份;语言目录由正常的 HTML 生成流程自动更新。

此目录现在作为唯一正式源码维护。日常修改直接在这里完成,不要用旧开发目录导出来覆盖这里。修改文档后先运行 node tools/build_readme_html.mjs,发布前运行 python3 tools/refresh_release_manifest.py 和 python3 tools/verify_release.py。刷新只处理明确的发布文件和已登记页面,不删除或自动纳入临时文件。

The release directory contains current library source and headers, CMake package support, runnable examples, active regression/functional tests, CI, current SPSC comparisons and block-size/backlog tests, published reports and their referenced evidence. LICENSE and NOTICE remain at the root.

发布副本包含现版源码、安装包配置、有效测试、全部可运行示例、中英文入口、当前性能测试程序、正式报告与其引用的复现数据。固定版本的对比队列头文件和原始许可证包含在 third_party/spsc/,同时提供版本与校验信息。临时笔记、目录副本、.DS_Store、构建产物和可选下载缓存不进入上传清单。筛选不删除原项目或目标目录中的任何文件;目标目录已有的非发布文件由 Git 忽略。

首页包含两组四图对比:8、16、32、64 B 消息的 Session 发送吞吐,以及批量发送后业务耗时与正常 13 ns 耗时的比值。两组图均直接读取保存的正式数据,不重新执行测试。

业务性能的当前入口是连续发送一批消息,对业务性能产生什么影响:每批从零积压开始,展示发送后业务耗时与正常耗时的比值。测试流程与复现命令和全部参数、原始样本一起发布。此前预填充大积压的报告与历史图表也保留,两种起始状态分别说明。

Shell
python3 tools/refresh_release_manifest.py
python3 tools/verify_release.py

The exporter follows local links, copies their targets and checks SHA-256 hashes. release-manifest.json lists each published file, size and hash. Measurement JSON/JSONL/CSV over 1 MiB is losslessly compressed in the destination, and published links are adjusted. compression-manifest.json records both hashes; tools/unpack_performance_data.py restores original paths and refuses to replace differing files. Recorded measurements, metadata and source archives are not rewritten. The exporter does not copy .git, create commits or publish anything. Differing destination files require --update. Extra destination files are never deleted.

代码阅读 · English HTML overview · 中文 HTML 首页 · GitHub publishing steps · Report index.

The current supported comparison entry is BRQ_BUILD_SPSC_BENCHMARKS=ON. The old BRQ_BUILD_BENCHMARKS and BRQ_BUILD_COMPARISON APIs are deprecated and produce a clear configuration error. Their historical source is preserved in the development directory and excluded from the current release copy.

正式数据中的源码归档与历史绝对命令路径属于复现证据,不能清洗或重写成当前路径;使用当前性能测试说明中的可移植命令自行重测。复制构造敏感性控制实验也保留。发布副本可以独立配置和测试,不依赖开发目录的未复制文件。