refactor(docs): point entry-file references at their new homes
AGENTS.md stopped being the store of record for build steps, Python env, hardware pins, doc conventions, log cost and task ownership. Those facts already live in docs, skills and role files; the entry file now only points at them. This commit moves every reference that used to name the entry file to the authoritative landing point, so a reader who follows a link arrives at the fact instead of at a sentence that no longer exists. What changed is links and prose, not behaviour. Code, scripts and tests only have comment and docstring lines touched; the only non-comment edit in the whole changeset is one note string inside the generated pin table JSON, and its generator was changed in the same step so the two stay byte-identical. New landing points created before the references were retargeted: - The console single-writer log design doc, section 7.1, is now the single authority for log cost: about 90 B flash and 216 B stack per DBG_ line, and the rule that deep call chains must predefine DBG_LINE_BUF_MAX. It also carries the full list of the twelve translation units that have tightened it, plus the grep command that decides the truth if the list and the code ever disagree. - The document writing standard, section 2, now holds the BOM list. - keil-build skill gains an exit code table: 0 success, 1 build failure, 2 BuildEnvError, 3 usage, 4 build lock held. This corrects a belief that was never actually written down anywhere: exit 2 does not simply mean environment error, argparse also exits 2 and the wrapper script was remapped so the two no longer collide. Regenerated and checked byte for byte: - The end-to-end architecture SVG in docs/images from its generator. - tools/netlist_semantics/pinout_kb.json from gen_kb.py. Both are idempotent; running the generators again produces no diff. Deliberately not touched, because machines read them: - scripts/check_bom_drift.py joins every line containing BOM and asserts four paths are present, so the entry file BOM line must stay one line. - scripts/gen_task_table.py reads the TASK_TABLE anchors directly. - scripts/rename_maps and scripts/archive keep their historical wording; they describe what happened, not what is true now. Verified: doc links report the same six pre-existing findings as the base commit and no new ones, generated-fresh passes, bom drift is clean across 101 files, and AGENTS.md itself is unchanged in this commit.
This commit is contained in:
@@ -7,8 +7,8 @@
|
||||
* 差异见下方"落地差异"。
|
||||
* 落地差异(相对早期示意稿,均为有意):
|
||||
* 1. 断言点**不再额外发一条 DBG_ERROR**:钩子本身就打印 file:line(断言唯一有
|
||||
* 价值的现场信息),而每条 DBG_* 调用点约 90 B Flash + 216 B 栈(AGENTS
|
||||
* 「日志不是免费的」);断言点又常处在"内核状态已不可信"的现场,走裸控制台
|
||||
* 价值的现场信息),而每条 DBG_* 调用点约 90 B Flash + 216 B 栈(见
|
||||
* docs/子系统设计/控制台单写者日志设计.md §7.1);断言点又常处在"内核状态已不可信"的现场,走裸控制台
|
||||
* 比走日志行缓冲更稳。
|
||||
* 2. 本头落在 Drivers/BSP 根目录(与 dbg_log.h、bsp_err.h 同级),不是示意稿写的
|
||||
* App/util:它是纯宏叶子能力(无状态、无数据、不依赖任何上层服务),BSP 与
|
||||
@@ -120,7 +120,7 @@ extern void vApplicationAssertFailed(const char *file, long line);
|
||||
* 4. 断言条件**不得带副作用**:关闭态不求值、打开态才求值,带副作用等于让行为
|
||||
* 随开关漂移——这是本宏唯一真正危险的误用形态。
|
||||
* 5. 台架口径:MCU 钩子打印以 [ERR] 开头 → 真机上断言一旦触发,/serial-boot-test 必然判本次
|
||||
* 失败,这是刻意的(AGENTS「Forbidden 标记含 [ERR]」/ 出现 Fault 即不通过)。
|
||||
* 失败,这是刻意的(Forbidden 标记含 [ERR] / 出现 Fault 即不通过)。
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in New Issue
Block a user