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:
@@ -20,7 +20,7 @@
|
||||
* recv 快路径与 EOF vs WOULDBLOCK、connect 命令被拒的回滚、accept 的
|
||||
* closed-with-readable 排空接受、close 的先结算再关芯片。
|
||||
*
|
||||
* ⚠ 断言只钉**真实契约**(AGENTS 模块约定 + docs/网络/网络自愈架构设计.md §4.10 +
|
||||
* ⚠ 断言只钉**真实契约**(docs/网络/网络自愈架构设计.md §4.10 +
|
||||
* 源码注释里的定案编号),不钉假件规则:凡"因为假件这么做所以断言这么做"的一律不写。
|
||||
*
|
||||
* 入口:int main(void),返回 0=PASS / 1=FAIL。跑法见同目录 run_unit_test.py。
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
* 分片 3:跨上下文消息面(net_process_messages 全分派 + 结果经任务通知值回传)
|
||||
* 前置:net_socket_test.c 已纳入生产源与假内核/假芯片/兄弟模块桩(同一 TU)。
|
||||
*
|
||||
* 这一片是整套里最值钱的部分,钉的是 AGENTS 模块约定的两条硬契约:
|
||||
* 这一片是整套里最值钱的部分,钉的是模块约定的两条硬契约:
|
||||
* A.「所有 net_* socket 操作经 netMsgQueue 在 netTask 串行执行」
|
||||
* B.「net_* 公开 API 的错误码经任务通知值回传:net_msg_t 是按值拷入队列的,
|
||||
* netTask 改的是自己那份副本,调用方永远看不到 → 错误码搭 xTaskNotify 通知值回来;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/*
|
||||
* 分片 4:net_poll 中断分派、监听/可读闸门、close 与 drop_conn 的拆除序列
|
||||
*
|
||||
* 这一片钉的是 AGENTS 模块约定里**没有文档就无法发现**的那条芯片约束:
|
||||
* 这一片钉的是模块约定里**没有文档就无法发现**的那条芯片约束:
|
||||
* 所有 CH395F 中断在 net_poll() 内经 GET_GLOB_INT_STATUS 集中读取并清除,不得在
|
||||
* ISR 或其他地方单独处理。全局寄存器整体读即清、芯片无按位清除手段,而 net_poll
|
||||
* 只在全局位为 1 时才读该 Socket 的 SINT → 顺手全量清一遍等于把别的在用 Socket 的
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
* - 本分片只测**队列化之后**新增或变化的决策:出参经 per-fd 槽回传、挂起 recv、
|
||||
* 截断排空、模式切换、以及"任何一条出口都必须通知调用方"。
|
||||
*
|
||||
* ⚠ 断言只钉真实契约(AGENTS 模块约定 + docs/芯片手册/CH395F.md §9.2.4 +
|
||||
* ⚠ 断言只钉真实契约(docs/网络/网络自愈架构设计.md §4.10 + docs/芯片手册/CH395F.md §9.2.4 +
|
||||
* docs/问题记录/CH395F_Trap_Records.md),不钉假件规则。
|
||||
*
|
||||
* 创建日期:2026-11-03
|
||||
@@ -506,7 +506,7 @@ static void tc_udp8_pending_cancel(void)
|
||||
reset_all();
|
||||
}
|
||||
|
||||
/* ================= UDP-9 出参互斥与泄漏(AGENTS 禁止的回传字段,本改造的替代面) ================= */
|
||||
/* ================= UDP-9 出参互斥与泄漏(禁止的回传字段,本改造的替代面) ================= */
|
||||
|
||||
static void tc_udp9_outparam_slot(void)
|
||||
{
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
为什么要主机侧单测(而不是只用台架):
|
||||
net_socket.c 是本产品**唯一的 SPI 串行化点**:所有 net_* 公开 API 把请求按值拷进
|
||||
消息队列,由 netTask 串行执行,结果只能经 xTaskNotify 的 32 位通知值回来
|
||||
(net_msg_t 是按值入队的,netTask 改自己那份副本,调用方永远看不到——AGENTS
|
||||
(net_msg_t 是按值入队的,netTask 改自己那份副本,调用方永远看不到——模块
|
||||
模块约定明写"勿给 net_msg_t 加回传字段")。这条链的正确性取决于两个任务的
|
||||
交错时序,真机上"通知丢了"表现为永久挂死并被看门狗复位,日志里只剩一条
|
||||
[ERR];而错误码本身还按任务隔离,跨任务覆写只会让排障读到别人的码。
|
||||
|
||||
@@ -4,7 +4,8 @@
|
||||
* 同名文件)。net_socket.c 有 11 条 DBG_ERROR + 6 条 DBG_INFO,其中
|
||||
* 「短写必留痕」「版本门控拒置 bit3 必 [ERR]」「open 失败必 [ERR]」
|
||||
* 「close 复位没成也放行仍要留痕」这四条本身就是可断言的契约。
|
||||
* 本模块在 include 本头之前把 DBG_LINE_BUF_MAX 设为 128U(AGENTS 深调用链纪律),
|
||||
* 本模块在 include 本头之前把 DBG_LINE_BUF_MAX 设为 128U(深调用链纪律 →
|
||||
* docs/子系统设计/控制台单写者日志设计.md §7.1),
|
||||
* 桩不关心缓冲大小,只数条数。
|
||||
* ⚠ 仅供主机侧单测使用,不参与 MCU 构建。
|
||||
* 创建日期:2026-10-24
|
||||
|
||||
Reference in New Issue
Block a user