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、无行尾空白）。
5.9 KiB
5.9 KiB
doc-links — 文档引用一致性（路径存在性 + 章节号存在性 + 文件命名）
一句话：它管**"你引用的东西还在不在"——文件路径、
§小节号、文件命名合法。 它不管**你引用的那节内容还是不是你要讲的事（见 §6）。规范 =docs/文档规范.md。
- 配置：
entry: python scripts/check_doc_links.py --sections-strict，pass_filenames: true，files: \.md$（只跑改动的.md，但脚本内部对全库做一次--all复核更常见）。
1. 它在查什么
| 类 | 写法 | 解析基准 |
|---|---|---|
| A | Markdown 链接 [文本](相对路径) |
相对当前文档所在目录 |
| B | 反引号路径引用 `docs/xxx/yyy.md` |
相对仓库根（本仓约定：文档互引一律用仓库根相对路径） |
| C | 目录名 / 文件名规范 | 不得含空格与路径敏感字符 |
| D | 章节引用 `路径.md` §N.M |
目标文档里必须真有这个编号的标题 |
D 类刻意只校验紧邻写法：文档名与 § 之间只允许空白、反引号、括号。实测这样能把误报压到 0。
钩子带 --sections-strict，所以"紧邻/裸名/前缀/别名"几种不合规写法都会拦提交。
2. 为什么要它
- 本仓文档互引极密（实跑：2594 处章节引用），一次改名/删小节历史上要扫 10~30 个文件， 手工扫既慢又漏。
- 真实案例（本次写文档时发生，且这段解释本身又触发了一次同样的报错）：我在正文里只写了 本文档自引用——恰好本文档没有那个编号的小节，于是提交前被拦。这类"看着是人话、机器判成悬空" 的写法，靠这份门禁一条命令就能挑出来。
- 另一类真实价值：把某小节内容搬去别的文档后，旧引用若还指向原文档的同号小节，只要那个 号还在，它是合法的但错的——本门禁不报（见 §6 第 3 条），但号被删掉的情形会报， 而"搬家时顺手删旧号"是本仓的常规做法，所以多数迁移错误能被抓到。
3. 触发面
- 只跑
*.md；第三方目录由exclude控制，脚本内再兜一层；docs/芯片手册/属外部资料， 链接形态与文件名都不受控 → 整体豁免。 - 每次全库复核会打印统计。实跑：149 篇文档、章节引用 2594 处、机器可判定 1504 处（58%）； 跳过分类：昵称式 25 / 非文档锚点 13 / 变更记录 655 / 外部手册 341 / 省略文档名的跨文档引用 2 / 目标无编号体系 54 / 无法判定 0。
4. 报错怎么读
[示例] docs\代码规范\pre-commit使用说明.md:528 [章节引用（自引用）] §4.3（… 无此编号标题）
修法：确认它到底指哪篇 → 写成「`路径.md` §N.M」，或改指本文档现有编号。
- 单独跑：
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all --sections-strict； 想看"哪些引用判不了目标、建议怎么改写"：--section-todo。 - 合法的"故意引用不存在文件"的写法：行首/行内加
[计划]前缀（约定产物尚未创建）、 加[示例]标记（引用报错样例、日志片段），或在该行写"未创建 / 尚未创建 / 已删除 / 待排期"等状态词。
5. 好处
- 改名与挪目录有安全网（配合
scripts/rename_ref.py：git mv+ 自动改写全库引用 + 落盘后 自动跑本脚本复核），所以"改名"不再是靠人肉 grep 的危险动作。 - 把"引用要写全路径 + 紧邻编号"这条写作约定变成机器判定，读者永远能点开你指的地方。
6. 限制与盲区
- 只判存在性，不判语义。它只知道目标文档里那个节号还在，不知道那一节还在讲你要讲的事。 内容搬家而号还在 → 全绿但是错的。这是本门禁最大的盲区。
- 58% 的章节引用机器判不了（见 §3 的跳过分类）。其中"变更记录 655"是设计选择：历史行 不回改，所以不校验——代价是变更记录里的引用可以烂掉。
- 只校验紧邻写法：昵称式（文档简称 + 空格 + 节号）不校验。写法不紧邻 = 放过，所以规则是 "宁可啰嗦也要写全"。
- 表格里裸写的小节号、或"设计文档 + 编号"这种不写文件名的写法，会被当成本文档自引用 静默放过（本文恰好有同号小节就通过）。搬移内容时这是真踩过的坑。
- 豁免清单本身可被滥用：加个
[示例]就安静了。只有引用报错样例/日志片段才该用它。 - 只管
.md：代码注释里的文档引用不在范围内（那边靠人工与bsp-err之类的文档检查间接覆盖）。
补录（豁免与排除清单，迁移自原手册）：
- 排除目录：
.opencode/node_modules/、Lib/lvgl/、MDK-ARM/RTE/、docs/芯片手册/；simulator/已于 2026-10-11 从排除列表移除（其下三个 README 是本项目文档）。 - 状态词豁免的判定距离是引用附近 ±40 字符（未创建 / 尚未创建 / 已删除 / 待排期）。
- 规范依据 →
docs/文档规范.md§3（链接规范）与 §4（门禁）。 - 全库自检：
python scripts/check_doc_links.py --all（不带--sections-strict时只查路径与命名）。
7. 豁免与基线
- 没有"基线"概念：硬拦截，新写的引用必须合法。
- 有别名表
scripts/section_aliases.json：昵称 → 文档的映射，歧义就登记进去或把话写清楚。
8. 改这个门禁本身
- 放宽匹配（例如允许裸名引用）前先想清楚：误报压到 0 是靠"只认紧邻写法"换来的。
- 新增一类豁免，必须同时新增一类误报；把豁免写在
docs/文档规范.md与本节里，别只写进代码。
9. 变更记录
| 日期 | 变更 |
|---|---|
| 2026-10-23 | 首篇逐项文档（数据为当日实跑：149 篇 / 2594 处章节引用 / 可判定 58%） |