Documentation
¶
Overview ¶
hygiene —— 仓库卫生门禁:被跟踪的编译产物二进制不得入库(issue #413)。
为什么要有这道门禁 ¶
2026-11-18 实录:仓库根跟踪了一个 3.5MB 的 Mach-O 二进制(cmd/docsync 的 本地产物,引入于 b469d8b)。危害有三层:
- 跨平台 checkout 拿到的是**不可执行的机器码**(它是 darwin/arm64 的);
- 二进制与源码可能不同步——review 时看到的是一个改不动的 blob diff;
- 每次 clone 多下 3.5MB。
它是 `make docsync` 的产物,仓内已有**可复现的入口**,入库没有任何收益。
为什么判「被跟踪」而不是「文件存在」 ¶
与 modwork / modreplace 同口径:本地构建产物留在工作树里是**正确状态** (.gitignore 收着就行),进了版本库才是缺陷。判「文件存在」会把「本地刚 构建完」报成违规——那是噪声,而噪声活不过第三个提交。
为什么判魔数而不是扩展名 ¶
扩展名可以改:把 docsync 改名叫 docsync.bin 就绕过了扩展名判据。魔数是 **内容事实**——ELF/Mach-O/PE/ar/wasm 的文件头写死了格式标识,改不改名都在。
失败形态 ¶
非零退出 + 逐条列出(路径 / 命中的格式 / 修法)。git 不可用时**报错退出** 而不是静默跳过——判据跑不起来却报绿,是最贵的失效形态。
Click to show internal directories.
Click to hide internal directories.