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:
@@ -18,7 +18,7 @@
|
||||
* 可控"芯片此刻还有多少字节可读";dbg_log 计数;net_set_errno 记录。
|
||||
*
|
||||
* 为什么要主机侧单测(而不是只靠台架):
|
||||
* 1. AGENTS 模块约定写着:net_* 公开 API 的错误码经**任务通知值**回传,因为 net_msg_t
|
||||
* 1. 模块约定:net_* 公开 API 的错误码经**任务通知值**回传,因为 net_msg_t
|
||||
* 是**按值拷入队列**的,netTask 改的是自己那份副本,调用方永远看不到;也**勿给
|
||||
* net_msg_t 加回传字段**(加了只会让调用方读到栈垃圾)。这条契约在真机上表现为
|
||||
* "偶发拿到 0 或正数却不知道为什么",日志无痕;在 PC 上必须把 xTaskNotify 做成
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
退出码:0=PASS / 1=测试失败 / 2=环境错误。
|
||||
|
||||
设计依据:AGENTS.md 模块约定(错误码经任务通知值回传)、
|
||||
设计依据:模块约定(错误码经任务通知值回传,见 docs/网络/网络自愈架构设计.md §4.10)、
|
||||
docs/网络/Net层阻塞模型架构设计.md、docs/测试说明/单元测试/主机单测覆盖率口径.md §9
|
||||
创建日期:2026-10-23
|
||||
"""
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
* 模块名称:主机侧单测桩 - net_socket.h(NET 域共享形态,见 net_listener 同名文件)
|
||||
* 模块功能:net_pending.c 需要 net_set_errno() 与 NET_ERR_RETURN_1()(写法照抄真实
|
||||
* net_socket.h:528/532);socket 状态与错误码常量取**真实** net_types.h。
|
||||
* 本模块**不用** net_get_sock——tick 收的是 net_sock_t 表数组(AGENTS 模块
|
||||
* 本模块**不用** net_get_sock——tick 收的是 net_sock_t 表数组(模块
|
||||
* 约定:net_get_sock 对未用槽位返回 NULL,而 tick 必须读 in_use==0 兜底)。
|
||||
* ⚠ 仅供主机侧单测使用,不参与 MCU 构建。
|
||||
* 创建日期:2026-10-23
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* 的假件:xTaskNotify 把 (目标句柄, 通知值) 记进日志,
|
||||
* xTaskGetCurrentTaskHandle 返回一个固定的"属主任务"句柄。
|
||||
* ⚠ 仅供主机侧单测使用,不参与 MCU 构建。
|
||||
* 为什么这两个假件是重点:AGENTS 模块约定写着"net_msg_t 是按值拷入队列的,
|
||||
* 为什么这两个假件是重点:模块约定写着"net_msg_t 是按值拷入队列的,
|
||||
* netTask 改的是自己那份副本,调用方永远看不到 → 错误码必须搭通知值回来",
|
||||
* 还写着"勿给 net_msg_t 加回传字段"。这条契约只有把 xTaskNotify 做成可观测的,
|
||||
* 才能在主机侧被验证(否则"调用方拿到错误码"这件事在 PC 上根本无法发生)。
|
||||
|
||||
Reference in New Issue
Block a user