wandering1
6822726b2c
用户一句"现在门禁都在干什么，我一概不知"引出的收尾。原手册 §2 有 27 个逐钩子小节，只回答 "拦了什么、怎么配"，回答不了"什么时候会骗我"；docs/门禁说明/ 已把逐项详解（含"限制与盲区" 一节）建好，本笔做收敛：同一事实只留一处（docs/文档规范.md 的要求）。 **先搬后删**（否则收敛等于丢事实）：旧 §2 里独有条目逐篇折回，共 18 处插入、15 篇受益。折回的 东西包括：六套主机单测的来历与用例规模（13/36/82/46/32/149 断言，含 nand-port 的"与旧算法 对照"）与"改动公共骨架 unit_test_harness.py 会同时触发 16 个钩子"；UI 页面**两层注册**（构建 注册 vs 框架注册：枚举 + s_defs[] 描述符表）与"豁免不整目录一刀切"；lv-conf-sync 首次落地清掉 26 个 LVGL 9.3 不存在的选项、3 处重复定义、10 项隐式开关显式化，以及 ALLOW_DIFF 端专属白名单 与必须穿过 lv_conf_internal.h 里那层 KCONFIG 包裹；cubemx-survival 的 16 项清单、断言前先剥 C 注释（本仓注释刻意引用历史代码，不剥就恒定误报）、旧手册"自造标记区"建议与看门狗文档实测 教训之间的优先级；id-check 顺带收编 check_test_traceability.py、裸形同字母多义属**显式承认的 盲区**、--update-baseline 只许涨；layer-deps 的注入自证与报错时三条修法（注入回调 / 上层递数据 / 才谈 ALLOW）；coding-standard **nand_ftl.* 也在排除清单**（我先前那篇漏了）；test-suite-switch 的剥注释判定与派生宏白名单；mem-budget 两类软提醒不拦、退出码 2 是解析失败不是通过；doc-links 的排除目录与状态词 ±40 字符距离；task-table 改栈三步；gitlint 报错样例；no-mojibake 的修复路径。 **顺带抓到旧文档两处错**（记进文档，不悄悄改）：一是 check-added-large-files 的阈值旧手册写 "单个文件 > 1MB"，按本机安装的钩子源码实测是 --maxkb 默认 **500**（500 KB）——已更正，并把 "本目录任何默认值都以实测或安装的钩子源码为准"写进 end-of-file-fixer 当反面教材；二是 **ui-golden 在旧手册里连小节都没有**，只活在配置注释里：除了"有基线不等于有门禁"，这是另一种 失踪——有钩子、没文档。 手册 §2 改写为三节：迁移说明 / **旧编号 → 新文档 查号表**（历史引用靠它读，旧号按"冻结历史不 回改"保留）/ **跨钩子通用机制**：两阶段与换机必须重装 hooks 才带 commit-msg、stash 陷阱、 always: true 已废、改写型与只读型豁免不对称、增量拦截三段式且刻意没有 --write、没有 .map 是 "跳过"不是"通过"、改配置的验收是看目标钩子出现在输出里且不是 Skipped、新增门禁三步必须做 注入自证且"限制与盲区"不许留空，另有快速自查入口。手册 707 行 → 273 行。 引用**按内容**重指（只核编号存在与否不够，同号小节会被当本文自引用静默放过）：编号规范、 scripts/README（顺带更正那里过时的 warn-only 说法，早已关闸为增量拦截）、RAM 使用分析与优化 方案、测试开发标准流程、lvgl-simulator skill、AGENTS 文档表（拆成"每门禁一篇详解"与"通用 机制"两行）、.pre-commit-config.yaml 头注释、docs/README.md 描述、手册自身 §5.5 与 §6 的两处 内部引用。另：表格里的裸节号会被 doc-links 判成本文自引用，查号表统一写成不带 § 的形态。 写说明过程又被自家门禁拦一次：gitlint 篇里引用报错样例时写了两个规则号字面量，被判形态不合规 → 改成中文描述，没有往台账里塞 reason 解决。 验证：纯文档与注释改动，不动代码，Program Size 不变，故不跑 @build/@test； check_doc_links --all --sections-strict **171 篇 0 问题**；id-check 增量拦截通过； pre-commit run **RC=0 / 13 项 Passed**；28 个改动文件字节卫生 **0 异常**（无 BOM、无 CR、 无 U+FFFD、均 LF、无行尾空白）。
2.5 KiB
2.5 KiB
end-of-file-fixer — 文件末尾必须恰好一个换行（改写型）
一句话：文件最后一个字节必须是换行、且末尾不能留多余空行；改的是工作区，需要再
git add一次。
- 配置：官方
pre-commit-hooksv5.0.0，exclude: *cubemx-generated（与行尾空白同一段豁免）。
1. 它在查什么
- 末尾无换行 → 补一个；末尾多余空行 → 删到只剩一个换行；空文件（0 字节）不动。
2. 为什么要它
- 无末尾换行的文件在
git diff、cat、grep拼接时会与下一条输出黏在一起； - 避免
\ No newline at end of file这种噪声长期留在历史 diff 里。性质上属预防性。
3. 触发面与豁免
- 与
trailing-whitespace共用生成文件豁免（.ioc、Src/、Inc/、HAL/CMSIS/中间件、 Keil 工程与.map等）——理由相同：那是工具产物。
4. 报错怎么读
Fix End of Files.........................................Failed
Files were modified by this hook.
git add被改文件后重新提交。- ⚠ stash 陷阱（本仓踩过）：pre-commit 跑钩子前会 stash 未暂存改动，钩子看到的是"没有你
中间状态"的树；改代码同时更新基线/受管区时，务必先
git add再跑钩子，否则会假报警。
5. 好处
- 全库文件末尾形态统一，脚本类工具（按行读文件的门禁脚本自己也算）行为更可预期。
6. 限制与盲区
- 只管文件末尾：行间的多余空行、缩进风格都不管；
- 不查编码：BOM 有无与丢失由构建期
#870-D暴露，U+FFFD由no-mojibake管，且后者 只覆盖 C/H——文档侧的字节卫生目前靠人工（本目录作者每次交付前逐文件核 BOM/CR/EF BF BD）； - 只处理本次涉及的文件，历史文件不会被批量整理（避免一次性巨大 diff）。
- 迁移时发现的一条已更正的旧错误值得记在这里：原手册把
check-added-large-files的阈值写成 1 MB， 实际默认是 500 KB（--maxkb默认 500）→ 见docs/门禁说明/check-added-large-files.md§1。 提醒：本目录任何"默认值"都应以安装的钩子源码或实测为准，不要抄旧文档。
7. 豁免与基线 / 8. 改这个门禁本身
- 无基线。若真有"某类文件必须无末尾换行"的需求，加豁免并写明原因，别用
--no-verify绕过。
9. 变更记录
| 日期 | 变更 |
|---|---|
| 2026-10-23 | 首篇逐项文档 |