Files
STM32F4-Base/docs/门禁说明/font-charset.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

4.6 KiB
Raw Blame History

font-charset — UI 字符集差集(防"缺字显示白框")

一句话:本仓唯一中文字体是子集字体;UI 字符串用了没进字体的汉字,上机就是空白方框, 没有日志、没有报错。本门把"改了 UI 文案要重跑字体生成链"这条约定机械化。

  • 配置:entry: python scripts/check_font_charset.py、pass_filenames: false、 files: 覆盖 Drivers/BSP/UI/、App/task/ui_task.(c|h)、ui_cn_chars.txt、tools/font_gen/。
  • 生成链(四步,见 font-regen skill):UI 源码 →extract_cn.py→ ui_cn_chars.txt →make_font.py→ ui_font_cn_12.c。

1. 它在查什么(两段链条,缺一环即白框)

段 比对 不满足时
A 必需字符集(源码在用 ∪ KEEP_EXTRA 保留字) vs ui_cn_chars.txt 必需而 txt 无 → GAP FAIL(字体必然缺字形);txt 有但非必需 → 告警不拦(只费 Flash);--strict 升级为 FAIL
B ui_cn_chars.txt vs ui_font_cn_12.c 的 cmap txt 有而字体无 → GAP FAIL(转换器对缺字形/低码位会静默丢字)

A 通过 + B 通过 ⟹ 字体覆盖"源码在用"与"刻意保留"的每一个字。 KEEP_EXTRA 的存在理由:防止将来 extract_cn.py 按"源码已不用"静默删掉已落盘记录里还在用的字。

  • 单一规则源:本脚本不自创第二套"从源码里找汉字"的规则,而是复用 tools/font_gen/extract_cn.py 的 SCAN 清单与 collect() 状态机(跳过注释与字符常量、只取双引号字符串)。两处各写一套解析, 就会出现"门禁说够、生成器说不够"。
  • 典型报错形态:[GAP] 字体缺字 1 个(在字符集、不在 ui_font_cn_12.c 的 cmap -> lv_font_conv 静默丢字,上机白框),并点名码位(含 U+ 码点)。

2. 为什么要它

  • 生成期的 verify_coverage() 只校验"txt ⊆ 字体 cmap",管不到"源码用到的字有没有进 txt"; 改了 UI 字符串却忘跑生成链时,此前提交期没有任何门禁能拦——只能靠肉眼截图发现白框。

  • 有牙实测(首次落地):注入都打在临时副本上(用 --chars / --font 覆盖,不碰仓库文件): ① 从字符集清单里删掉一个符号 → 第一段链条 FAIL 并点名该码位;② 从字体副本里删掉同一码位 → 第二段链条 FAIL。两段各测一次才算证明链条闭合。

3. 触发面

  • 只跑改动的 .c/.h(types: [c])。

4. 报错怎么读 / 单独跑

  • & '.venv\Scripts\python.exe' scripts/check_font_charset.py --strict(严格档:冗余字也拦); --chars / --font 换输入用于测脚本自己。
  • 修法是重跑生成链(font-regen skill 四步),不是把字从 UI 里删掉凑绿。

5. 好处

  • 把一种"上机才知道、且完全没有日志"的显示缺陷压到提交前;
  • KEEP_EXTRA 用"逐条带理由"的形式沉淀,避免将来被无声删掉。

6. 限制与盲区

  1. 只看 C/H 源文件:types: [c]。写进 ui_menu_tree.txt(生成菜单表的文本源)里的汉字 不在直接扫描面内——它靠"重新生成 UI 表 → 落到 .c → 被扫"这条间接路径生效;手工改生成物 或跳过生成器时,覆盖关系可能出现空洞。
  2. 必需集来自"源码里出现的汉字",运行期拼出来的字符串(格式化进来的字、外部配置文件里的字、 记录内容回显)完全在视野外——那类白框本门照不到。
  3. 只校验码位覆盖,不校验字形是否美观/是否为所需点阵尺寸。
  4. 拉丁字母、数字、标点不在本门范围(另有字体与布局约定)。
  5. --strict 不在钩子默认档位里(默认只拦 GAP):冗余字形长期靠人自觉清理。
  6. 字体文件本身若被手工编辑(不跑生成器),A/B 两段仍可能同时"通过"而与实际 cmap 不符—— 因为它读的就是生成物。

7. 豁免与基线

  • KEEP_EXTRA 是刻意保留清单(存量 + 逐条理由),性质同 registration-check 的已知缺口表; 新增要写理由,删掉等于放弃保护。
  • 没有"只减不增"的债务基线。

8. 改这个门禁本身

  • 放宽"必需集"来源(比如不再扫某个目录)前先确认该目录的字最终确实会进生成链;
  • 与 ui-golden 是互补关系:本门管"有没有字形",golden 管"像素对不对"。

9. 变更记录

日期 变更
2026-10-23 首篇逐项文档(两段链条判定口径 + 生成期校验覆盖不到的那一环)