dc44c1e54e
用户诉求原话:"现在门禁都在干什么,我一概不知。" 原有文档回答"有哪些钩子、怎么配",回答不了 "这一条到底在拦什么、什么时候会骗我"。本目录按**每种门禁一篇**补齐 23 篇(39 个 hook id 全覆盖: 16 个主机单测是同机制 16 实例合一篇;cppcheck 与 test-cppcheck 是同工具两套范围合一篇), 文件名用 hook id,与提交输出里的名字一致、可 grep。 八段固定结构:查什么 / 为什么要它(拦下过什么真事)/ 触发面 / 报错怎么读 / 好处 / **限制与盲区** / 豁免与基线口径 / 改门禁本身要注意什么。最后一节是这批文档存在的理由—— 只看"拦了什么"的文档会让人以为绿就是对的;本仓三个增量拦截门禁(layer-deps 6 条、bsp-err 38 条、 id-check 台账 640 处)的绿灯含义只是"没比上次更差"。README 另立"三种拦截姿态"一节:改写型 / 硬拦截 / 增量拦截,分清才知道报错时该改代码还是该还基线。 有实证的地方全部带数字,没实证的地方直接写"预防性、未记录到实际拦截案例"(不编故事): · cppcheck:把 simulator/ 纳入受检后立刻揪出 sim_syslog.c 真实空指针;test/ 曾有 s_rx_buf 使用先于声明;**并记入两条实测负结果**——它对 14 处丢弃 HAL_SPI_* 返回值与"未初始化局部量 进 P_FAIL 判定"一条不报(这正是 consume-result 的由来)。 · lv-conf-sync:漂移导致 64,576 B 死代码入库(旧镜像的 23.5%),且 golden 跑的是模拟器那份配置。 · cubemx-survival:2026-09-29 一次重生成覆盖 4 处定制(P0×1+P1×2+P2×1),且不报编译错。 · registration-check:rs485_task.c、lftpd_log.c 两处都没注册 = 从不参与编译的死代码;第四类 "页面描述了但没接进 s_defs[] 表"编译链接全过,前三类完全照不出。 · test-suite-switch:实测已提交的 HEAD 里 TEST_SUITE_CH395F 就是开着的,.map 含 34 处 test 代码。 · task-table:2026-09 两张表都比源码落后一大截(写 2048/4096/…/16384,实际 1024…512)。 · mem-numbers:2026-09-26 复核,文档写 82,048 B / 62.6%,实际 87,040 B / 66.4%;Flash 写 249,432 / 23.8%,实际 261,932 / 25.0%。 · ui-golden:注入 .top_y +3 像素 → golden FAIL 点名"1366 px 差异"、退出码 1;并把"有基线 ≠ 有门禁"与"逼人 --no-verify 的门禁等于没有门禁"两条选型依据写进去。 · check-yaml:本仓已移除的 always 键只告警 Unexpected key(s) 然后忽略——配置"看起来生效其实没 生效"而本门全绿,所以验收方式是实跑看目标钩子是 Passed 还是 Skipped。 · no-mojibake:types: [c] 只管 C/H,**文档侧乱码无人管**——覆盖面与需求错配定性写进限制一节。 盲区写法示例(每篇都要求写真实限度,不留空):layer-deps 只查直接 include、按 basename 匹配、 不查是否真的用到;font-charset 管不到运行期拼出来的字符串与配置文件里的字;host-unit-tests 用宿主 编译器、桩是第二份真相、include_dirs 手写、没有对应钩子的模块等于零回归;mem-budget 的 92% 是管理 阈值不是安全余量、.map 缺失即"通过式跳过";registration-check 不看条件编译与注册指向是否正确; coding-standard 的 CODE-RULE-17 在无配对头时跳过、规则编号 14 作废不回收。 写文档过程自己被自家门禁拦了两轮,都按规矩改而不是绕过: ① doc-links 拦下我自己——我在解释"写 §数字 而没紧邻文档名会被判成本文自引用"这段话里,正好 就犯了这个写法(两处),另有一处示例输出未标记;改成正例写法 + [示例] 标记。 ② id-check 拦下 7 类新账:示例报错行里的号、档号引用未紧邻文档名、说明"裸形不合规"时自己写了 裸形。全部改成平实描述或补文档名、给样例加 [示例],没有一条是往台账里塞 reason 解决的。 这两次本身已写进相关篇目的"限制/变更记录",是这套文档最实在的注脚。 同步:手册 pre-commit使用说明.md 的 §2 顶部加指针(逐项详解已迁往本目录;两处收敛为"通用机制 + 总览 + 指针"排在 docs/门禁说明/README.md §4 的下一步,并注明收敛要按内容重指既有引用——只核编号 存在与否不够);README 索引 23 行状态全部置为已写、文档列改为可达链接。 验证:纯文档,不动代码与构建产物;check_doc_links --all --sections-strict **171 篇 0 问题** (新目录 24 个文件的内部链接与跨文档引用都纳入判定);id-check --strict 增量拦截通过;本次受影响 文件 pre-commit run **RC=0**;24 个文件字节卫生 0 异常(无 BOM、无 CR、无 U+FFFD、均有尾换行)。
4.0 KiB
4.0 KiB
cubemx-survival — CubeMX 重生成的定制存活审计 + 漂移检测
一句话:CubeMX 重生成会静默覆盖
USER CODE标记区之外的一切定制,而且多数不报编译错, 只在真出故障时才暴露。这一门把"易失清单 + 关键位置哈希"钉成基线,重生成后一眼看出被改了什么。
- 配置:
entry: python scripts/check_cubemx_survival.py --check、pass_filenames: false、files:覆盖.ioc、Src/**、Inc/**。方法论:docs/子系统设计/看门狗设计说明.md§10.2 与 §10.3。
1. 它在查什么
- 存活审计:逐项检查"重生成易失清单"里的定制是否仍在预期位置(清单以
must_contain等 断言表达),标记区外的存量给出显式警告; - 漂移检测:把关键位置哈希写进
.cubemx_survival_baseline.json,--check逐项比对, 任一项变化即 FAIL。
2. 为什么要它
- 实测记录:
.ioc里ProjectManager.KeepUserCode=true只保护USER CODE BEGIN/END之间; 2026-09-29 一次重生成覆盖了 4 处定制(P0×1 + P1×2 + P2×1)。典型形态:崩溃采集函数被打回 空while(1)、加固宏被整块删除——不报错,只在真崩的时候才发现没日志。 - AGENTS 把防丢失排成三层(L1 写进
.ioc→ L2 搬进USER CODE区 → L3 本门当审计兜底)。
3. 触发面 / 看不见什么
MDK-ARM/*.uvprojx不参与漂移检测(no_baseline=True):该文件每次@build后都被 UV4 自动改写(XML 归一化 +PackID降到本机 DFP 版本),参与检测等于每次构建后提交都被拦; 对本项只保留must_contain断言("源文件仍挂载")。- 只查清单里列了的东西:没写进清单的新定制 = 不受保护(这是清单式门禁的固有代价)。
4. 报错怎么读
CubeMX 重生成存活审计.......Failed
[FAIL] Src/main.c 缺少定制片段断言: fault_handler_enable
- 单独跑:
--report只看审计报告(不比对基线);确认改动无误后--write重建基线。 - 正确动作:先把定制搬回正确位置(优先 L1/L2),再
--write;直接--write等于宣布 "被覆盖掉的样子是新的正确答案"。 - 每次重生成后立刻跑(AGENTS 铁律),别等到提交时才发现。
5. 好处
- 把"重生成到底动了什么"从人肉 diff 变成一条命令的 FAIL 清单;
- 基线是位置哈希而不是内容全文,重排注释不炸、删掉定制必炸。
6. 限制与盲区
- 清单驱动:只保护登记过的定制。新写的标记区外定制不在清单里 → 静默丢失且不会报。
- 标记区内的内容不受本门保护(CubeMX 不动它,但如果我们自己写错,它也不判对错)。
- 不检测
.ioc配置项与生成结果是否自洽(比如某个外设被关掉,它不会告诉你)。 uvprojx无漂移检测(见 §3)→ 工程文件里被 UV4 抹掉的东西照不出;那条只能靠"改动不入库"的约定。- 基线文件是
.cubemx_survival_baseline.json(仓库根):它若被顺手--write,门禁当场失效且看不出来。--write必须与"确认过的改动"写在同一个提交里并说明。 - 它不判断定制是否仍然正确,只判断"还在不在原来的位置"。
7. 豁免与基线
- 基线 =
.cubemx_survival_baseline.json,语义与bsp-err/layer-deps的"只减不增"相反: 它是"确认后的快照",允许被--write前滚。因此它防的是意外,不防"有意改掉"。
8. 改这个门禁本身
- 新增受保护项:先想能不能落到
USER CODE区(L2)或.ioc(L1)——清单越长,人工维护越重; - 自造标记区(自定义
BEGIN/END名字)会被官方模板换代抹掉,别拿它当保护手段。
9. 变更记录
| 日期 | 变更 |
|---|---|
| 2026-10-23 | 首篇逐项文档(含 2026-09-29 一次覆盖 4 处的实测记录) |