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、无行尾空白）。
3.1 KiB
3.1 KiB
trailing-whitespace — 行尾空白（改写型）
一句话：它不改内容语义，只删每行末尾的空格/制表符；改的是工作区，所以会"先失败一次、你再提交一次"。
- 配置：官方
pre-commit-hooksv5.0.0；exclude: *cubemx-generated（YAML 锚点，与end-of-file-fixer共用同一段豁免清单）。
1. 它在查什么
- 每行行尾的空格与制表符；发现即就地删除，改动留在工作区（不自动进索引）。
2. 为什么要它
- 行尾空白在 diff 里表现为"整行被改"，是评审噪声主要来源之一；
- 与本仓另一条铁律同源：
*.uvprojx每次构建被 UV4 改写、不入库——工具抖动不该进历史。 性质上属预防性（本仓没有因它出过事故，它的价值是让 diff 保持可信）。
3. 触发面与豁免
-
豁免（锚点
cubemx-generated）：Src/、Inc/的.c/.h、Drivers/CMSIS/、HAL、Middlewares/、MDK-ARM/下的工程 / 散列 / 映射文件、.mxproject、.ioc。 -
理由：这些文件的事实源是
.ioc与工具链，每次重生成都按工具自己的风格写回（实测每次 重生成后Src/、Inc/下 10+ 个文件各被补行尾空白），整理它们只制造提交抖动。 -
⚠ 只读检查不受这条豁免影响：
cppcheck、乱码审计、存活审计、任务表、内存数字仍覆盖Src/、Inc/（cubemx-survival必须看到这些文件）。 -
豁免清单的精确条目（2026-10-09 定，两个改写型钩子共用同一份 YAML 锚点）：
Src/*.{c,h}、Inc/*.{c,h}、Drivers/CMSIS/、Drivers/STM32F4xx_HAL_Driver/、Middlewares/、MDK-ARM/*.{uvprojx,uvoptx,sct,map}、.mxproject、*.ioc。 -
⚠ 首次对全库跑（
run --all-files）会一次性批量改掉大量文件的行尾空白：行为正常、不改逻辑， 但要单独一笔提交，别混进功能改动里。
4. 报错怎么读
Trim Trailing Whitespace.................................Failed
Files were modified by this hook.（下面列出被改的文件）
- 这不是错误，是它的正常工作：
git add被改的文件，再提交一次即可。 - 想避免二次提交：提交前跑一次
& '.venv\Scripts\python.exe' -m pre_commit run --all-files。
5. 好处
- diff 干净；编辑器和工具链不会为"补不补空格"互相拉锯。
6. 限制与盲区
- 豁免是整目录级：
Src/、Inc/里我们手写的USER CODE区同样不被整理； - 只处理本次提交涉及的文件（
--all-files除外），历史里的行尾空白不动（这是优点也是盲区）； - 需要保留行尾空白的语法会被误伤（Markdown 用两个空格换行的写法；本仓不用这种写法）；
- 缩进混用、行间空行数量它都不管（Tab 缩进由
coding-standard的 CODE-RULE-08 管）。
7. 豁免与基线 / 8. 改这个门禁本身
- 无基线；豁免只有生成文件那一段锚点。新增豁免目录前先自问：是不是只是今天不想整理。
9. 变更记录
| 日期 | 变更 |
|---|---|
| 2026-10-23 | 首篇逐项文档 |