511fd30cc6
用户裁定:文档只写现状,历史流水一律删掉,过程查 git log。 - 43 篇「变更记录 / 修订记录」整节删除:继电保护规划 12.6 KB、产品 需求 11.8 KB、项目部署环境 5.5 KB、BSD Socket 指南 5.3 KB、架构 总览 5.0 KB、实机测试实施指南 3.8 KB 等 - 23 篇别处仍有指向:只留节名 + 一行「本文件不再记流水账,过程查 git log」,节号与锚点不位移(doc-links 不因此断链) - 5 篇整表保留(被当唯一证据 / 活台账引用):看门狗设计说明、配置 文件设计说明、RAM预算台账、内容页架构、本地工具路径环境变量方案 - 规范同步:文档规范 §5.1 改新裁定;测试文档模板规范删示例节与 登记句;测试开发标准流程 / UI 两篇 / 实机测试实施指南 / 四篇单测 说明 / 并行任务工作树方案 / 编号规范 的「登记变更记录」改「写进 正文」 - 技能同步:stale-doc-count-sweep / ui-verify / id-family 三个 SKILL 正文不再要求追加流水行(顺带消掉 SKILL.md:121「产品需求 §12」 失效引用) - 修 5 处悬空指针:采样有效性校验目录锚点、BSD 指南「文末变更 记录」、docs/README 过期描述、网络自愈架构两处指向面 72 篇文档净减 600 余行;check_doc_links --all --sections-strict 可判 定比例 61% → 78%、失效引用 0;静态门禁 passed=50 failed=0;gitlint 10 条历史提交信息 0 failed。 未提交他人在飞改动:.dsh/skills/keil-build/*(%SystemDrive% 守卫)。
5.8 KiB
5.8 KiB
cppcheck / test-cppcheck — 静态分析(同一工具,两套范围与严格度)
一句话:它管单个 C 文件内部能被看出来的一类错(越界、空指针、未初始化、资源/性能、 可移植性)。它不知道跨文件的事实,也不看我们的项目契约(那是
bsp-err的活)。
- 两个钩子:
cppcheck(项目自有代码,--enable=warning,performance,portability,style)、test-cppcheck(只扫test/,只开 warning,排除test/host/*/stub)。 entry: cppcheck、language: system、types: [c]、pass_filenames: true(逐文件分析)、--error-exitcode=1、--std=c99、--quiet、--inline-suppr。
1. 它在查什么
- 检查集 = cppcheck 的
warning/performance/portability/style四类(test-cppcheck只有warning)。 --inline-suppr:允许源码里用// cppcheck-suppress <id>单行抑制——这是唯一的一事一议豁免通道。- 抑制项清单(
args里逐条,别当噪音看,每条都是为了让它跑得动):missingIncludeSystem/missingInclude(我们没有完整的 include 环境,否则整文件解析不下去)、invalidPrintfArgType_sint/_uint(DBG_*宏展开后参数类型判定全是噪音)、unusedFunction(逐文件分析看不到调用方,误报连天)、unusedStructMember、noExplicitConstructor/useStlAlgorithm(C 项目无关)、constParameterPointer/constParameterCallback(建议加 const,属排版建议)、redundantAssignment、normalCheckLevelMaxBranches(分支数上限提示——见 §6 第 2 条)。 - include 路径:
Inc、App、Drivers/BSP、HAL Inc、CMSIS Include、FreeRTOS include。
2. 为什么要它
- 真实案例一(把
simulator/纳入受检的直接收获):本仓原先在顶层exclude里整目录挡掉simulator/,实测那是自研代码;纳入 cppcheck 后立刻揪出sim_syslog.c一处真实的空指针解引用。 - 真实案例二(
test/为什么单独立钩):test/board/下 6300+ 行 C 代码是要编进固件的, 此前完全豁免、只靠自律,出过s_rx_buf使用先于声明。基线:2026-10-03 全量实测 0 条 warning, 所以敢直接挂钩子(先清存量再关闸,顺序不能反)。
3. 触发面与看不见的地方
-
排除:
Drivers/CMSIS/、HAL、Drivers/BSP/NET/lftpd/、Drivers/BSP/dhara/、Lib/、Middlewares/、MDK-ARM/、test/(test/由第二个钩子负责)。 -
UI 生成文件(
ui_font_cn_12、ui_menu_tab)纳入受检——生成器按工程约定产出,不是第三方。 -
只在本机装了 cppcheck 时有效;CI 不跑构建类门禁(见
docs/CI/README.md)。 -
速度口径(原手册实测):单文件约 1~2 秒、全库约 5 秒,所以它能逐文件传参而不拖慢提交。
-
style 类别 95 项的逐项详解、配置参数与 YAML 引号陷阱 →
docs/代码规范/cppcheck使用说明.md; 本门只管钩子这一层。 -
典型报错形态:
[path/to/file.c:123]: (style) variableScope The scope of the variable ... can be reduced。
4. 报错怎么读
Drivers\BSP\XXX\x.c:123:45: warning: ... [someCheckId]
- 单独跑:
cppcheck --enable=warning,style,performance,portability --inline-suppr --std=c99 --quiet <文件>; 想复现钩子行为,照抄args里的抑制清单,否则噪音会让你误判成"新引入的问题"。 - 确属误报:在那一行加
// cppcheck-suppress <id>并写一句为什么;不要用--suppress=全仓关掉一类。
5. 好处
- 便宜、快、无副作用;对越界/空指针/未初始化这类"编译器不管但真会炸"的问题有效。
test/有独立档位,测试代码不再是法外之地。
6. 限制与盲区(今天最有料的一节)
- 它照不出"返回值被丢弃"。实跑证据:按本钩子自己的
--enable跑gd5f2gq5ue.c,对 14 处丢弃HAL_SPI_*返回值、以及"未初始化局部量直接进P_FAIL判定"一条不报—— 它假定被调函数会写出参,而我们的驱动在失败路径根本不写出参。这条负结果是bsp-err加consume-result检查的直接依据(另一半依据是 ARMCC v5 不认warn_unused_result)。 normalCheckLevelMaxBranches被抑制,但问题本身还在:默认检查级别会限制分支分析 (它会打印 "Limiting analysis of branches")。分支多的函数,它其实没分析完。想要全量得 显式--check-level=exhaustive(很贵,没挂进提交门禁)。- 逐文件分析(
pass_filenames: true):没有跨 TU 知识,unusedFunction因此被整条抑制; 跨文件的契约错误(A.c 改了返回值语义、B.c 的判据就失效)看不见。 - include 缺失被整条抑制 → 解析可能只到一半,越报"干净"越要留个心眼:某类检查是否根本 没跑到,本工具不告诉你。
- 它不懂项目约定:错误码、超时单位、分层方向、日志成本一概不管。
7. 豁免与基线
- 没有存量基线:新报即拦。所以存量必须先清(
test/就是这么做的)。 - 两类合法豁免:单行
// cppcheck-suppress(要写理由)、args里的整类抑制(要写清为什么整类都是噪音)。
8. 改这个门禁本身
- 加抑制项 = 永久放弃一类检查,必须在提交说明里写清噪音样本;能单行抑制就别整类抑制。
- 加/减
--enable档位前,先跑一次全库看新增多少条——直接挂钩子会把所有人卡在提交外。 - 两个钩子的抑制清单有意不同(
test-cppcheck少几条),改的时候别顺手"对齐"成一套。