Files
STM32F4-Base/docs/门禁说明/cubemx-survival.md
T
wandering1 6822726b2c docs(门禁说明): 手册 §2 收敛为通用机制与查号表,逐项详解归一到 23 篇
用户一句"现在门禁都在干什么,我一概不知"引出的收尾。原手册 §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、无行尾空白)。
2026-10-23 11:44:21 +08:00

5.3 KiB
Raw Blame History

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. 它在查什么

  1. 存活审计:逐项检查"重生成易失清单"里的定制是否仍在预期位置(清单以 must_contain 等 断言表达),标记区外的存量给出显式警告;
  2. 漂移检测:把关键位置哈希写进 .cubemx_survival_baseline.json,--check 逐项比对, 任一项变化即 FAIL。
  • 清单项共 16 项:IWDG 延后启动、崩溃采集 ×2、栈溢出检测、堆失败钩子、断言改造 ×2、看门狗模块 与工程挂载、复位原因锁存、HAL 驱动与使能宏、.ioc 关键项 ×3 等(清单本体在脚本里)。
  • 触发面还包括 App/util/task_watchdog.* 与 MDK-ARM/*.uvprojx(后者只跑 must_contain,见 §3)。
  • 防误报实现:断言之前先剥掉 C 注释——本仓多处注释刻意引用被替换掉的历史代码(例如 "原为 HAL_IWDG_Init(&hiwdg) 直呼"),不过滤就会恒定误报。

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 本门当审计兜底)。

  • 那一次被覆盖的具体内容:HardFault_Handler 的崩溃采集被打回空 while(1)、两个 FreeRTOS 加固宏被整块删除——两处都不报编译错,只在真出故障时才暴露。

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. 限制与盲区

  1. 清单驱动:只保护登记过的定制。新写的标记区外定制不在清单里 → 静默丢失且不会报。
  2. 标记区内的内容不受本门保护(CubeMX 不动它,但如果我们自己写错,它也不判对错)。
  3. 不检测 .ioc 配置项与生成结果是否自洽(比如某个外设被关掉,它不会告诉你)。
  4. uvprojx 无漂移检测(见 §3)→ 工程文件里被 UV4 抹掉的东西照不出;那条只能靠"改动不入库"的约定。
  5. 基线文件是 .cubemx_survival_baseline.json(仓库根):它若被顺手 --write,门禁当场失效且看不出来。 --write 必须与"确认过的改动"写在同一个提交里并说明。
  6. 它不判断定制是否仍然正确,只判断"还在不在原来的位置"。
  • 标记区外的存量只给 WARN(本仓现存:Src/stm32f4xx_it.c 的 3 个 Fault 处理函数、 Src/freertos.c 的栈注释)——CubeMX 不保护它们,只能人工盯。
  • 原手册在这里建议"仿照 HardFault_Handler 自造 USER CODE 标记区"把它们升级成受保护内容; ⚠ 而 docs/子系统设计/看门狗设计说明.md §10 记的实测教训是自造标记区会被模板换代抹掉。 两条不打架但优先级不同:能落 .ioc 或官方标记区,就别自造标记。

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 处的实测记录)