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:
+2
-2
@@ -133,7 +133,7 @@ int app_main_init(void) {
|
||||
* 用途:/serial-boot-test 把"芯片里正在跑的镜像"和"刚编出来的镜像"对上号。此前开机标记
|
||||
* 全是固定串(App init OK / Network Init / ...),旧镜像也照样全中,于是
|
||||
* "反复重下载、芯片一直是旧镜像"这类事故在自动闭环里完全不可见
|
||||
* (AGENTS.md 烧录铁律记的正是它)。代价:1 条 DBG ≈ 90 B Flash + 30 B 常量。
|
||||
* (`.dsh/skills/serial-boot-test/SKILL.md` 镜像身份核对一节的由来)。代价:1 条 DBG ≈ 90 B Flash + 30 B 常量。
|
||||
* ⚠ 戳只在**本 TU 被重编**时才刷新(增量构建),故本文件必须 #include
|
||||
* "test_config.h":否则只切套件宏(TEST_SUITE_* / ENABLE_DESTRUCTIVE_TESTS)
|
||||
* 不重编本 TU,产品镜像与测试镜像顶着同一个戳,戳校验对"两种构建互换"失明
|
||||
@@ -182,7 +182,7 @@ int app_main_init(void) {
|
||||
* 为什么放这儿而不是 defaultTask 的存储 bring-up:
|
||||
* ① 这一步只做 1 次 I2C 读 + 至多 1 次 I2C 写,落在内核启动前——
|
||||
* 单线程、非 ISR、调度器还没跑(本函数不调任何创建类内核 API,
|
||||
* AGENTS「内核前禁调创建类 API」那条与此无关);
|
||||
* 「内核前禁调创建类 API」那条与此无关);
|
||||
* ② 保持介质是 RTC 用户 SRAM,不是文件系统:不必等 STORAGE_READY,
|
||||
* 也就不必在喂狗点上碰卷锁(这条链上根本没有卷操作可言);
|
||||
* ③ sd2506_init 失败时这里自然走"读不到"那一支:状态标成不可信、
|
||||
|
||||
@@ -51,7 +51,7 @@
|
||||
#include "ui_data_feed.h"
|
||||
|
||||
/* 日志锚点:本文件只在"点表点数与快照点数不等"这一条静默漂移上打一条一次性日志
|
||||
* (每条约 90 B Flash,见 AGENTS「日志不是免费的」——常规发布路径刻意一条都不加)。
|
||||
* (每条约 90 B Flash + 216 B 栈,见 docs/子系统设计/控制台单写者日志设计.md §7.1——常规发布路径刻意一条都不加)。
|
||||
* ⚠ DBG_TAG 必须在 include 之前定义:dbg_log.h 的 DBG_ERROR 是宏,漏 include 时
|
||||
* ARMCC 只把 DBG_ERROR 当隐式声明函数放过编译期,错误落在链接期(L6218E
|
||||
* Undefined symbol),比漏写头文件本身更难归因 */
|
||||
@@ -787,7 +787,7 @@ static void feed_fill_info(ui_data_info_t *p_snap, uint32_t tick_ms) {
|
||||
* 一次空队列判断(drain 无请求时只是一次计数比较);
|
||||
* 差值法吸收 tick 回绕(同 App/algo/adc_health.h 的 now_ms 口径)。
|
||||
* 写路径失败态(ERR_RANGE/ERR_LOCKED/ERR_BUSY)走屏上通道,不打日志
|
||||
* (每条 DBG 约 90 B Flash + 216 B 栈,AGENTS「日志不是免费的」)
|
||||
* (每条 DBG 约 90 B Flash + 216 B 栈,见 docs/子系统设计/控制台单写者日志设计.md §7.1)
|
||||
*/
|
||||
void ui_data_feed_tick(void) {
|
||||
uint32_t now;
|
||||
|
||||
Reference in New Issue
Block a user