文档体系重组与 D-7 一致性门禁落地,清理芯片手册孤儿图片
- D-6 目录规范化:docs 根目录散落文档归入 UI设计/子系统设计/架构设计/审查记录/ 环境与部署/网络 等子目录,去掉目录名空格,重命名 嵌入式C语言代码规范_V1.0.md - D-7 三档一致性门禁:新增 scripts/check_doc_links.py(链接存在性)、 scripts/gen_task_table.py(FreeRTOS 任务表数值)、scripts/check_mem_numbers.py (内存/Flash 体积),均支持 --check/--write/--diff,pre-commit 钩子同步注册 - D-5 文档索引:新建 docs/README.md,新建 docs/文档规范.md 约束目录命名与链接写法 - D-1 芯片手册瘦身:删除 1069 张无引用孤儿图片(77.06 MB), docs/芯片手册 120 MB → 41 MB,已引用图片零断链 - 同步 C 源码注释中的文档路径引用(D-6 重组后),构建 0 错误 0 警告
This commit is contained in:
@@ -89,7 +89,7 @@ ROWS = [
|
||||
[L_HW],
|
||||
]
|
||||
|
||||
FOOT = "上层只依赖相邻下层(单向);UI 层与基础服务层同级并列,均使用顶层 net_cfg。跨层调用细节见 docs/项目架构总览.md §1.2 * 预留未接入调度"
|
||||
FOOT = "上层只依赖相邻下层(单向);UI 层与基础服务层同级并列,均使用顶层 net_cfg。跨层调用细节见 docs/架构设计/项目架构总览.md §1.2 * 预留未接入调度"
|
||||
|
||||
|
||||
# ----------------------------- 工具函数 -----------------------------
|
||||
|
||||
@@ -80,7 +80,7 @@ CONSUMERS = [
|
||||
]
|
||||
|
||||
FOOT = ("生产者与消费者互不知晓,只经事件组解耦;新增子系统 = 新 bit + 各自 wait/set,"
|
||||
"不改已有任务。详见 docs/项目启动顺序管理.md")
|
||||
"不改已有任务。详见 docs/架构设计/项目启动顺序管理.md")
|
||||
|
||||
|
||||
# ----------------------------- 工具函数 -----------------------------
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"""生成 docs/images/配置文件分层架构.svg —— 通用配置文件(/config.ini)分层架构图(纯标准库,无需第三方依赖)。
|
||||
|
||||
由 gen_net_stack_svg.py 复制改数据区:配置体系六层结构
|
||||
(docs/配置文件设计说明.md §4.1):
|
||||
(docs/子系统设计/配置文件设计说明.md §4.1):
|
||||
PC 端(编辑器/FTP 客户端)→ lftpd FTP 服务 → /config.ini 文件 → cfg_file 引擎 → 段适配(键表)→ 消费者。
|
||||
|
||||
用法(仓库根目录,任意 python3):
|
||||
|
||||
@@ -55,7 +55,7 @@ FIELDS = [
|
||||
TITLE = "RemoDispBus 协议帧格式"
|
||||
SUB = "整帧 = 4 + LEN + 1 字节 · 大端(网络字节序)· CRC = DATA 段逐字节异或(不含 TAG/CMD/LEN)"
|
||||
FOOT = ("TAG:0xAA=客户端帧 / 0xBB=服务端帧 · DATA 为变长段(LEN 字节,0–255,图中按 5 字节示意)· "
|
||||
"详见 docs/RemoDispBus协议与接收设计说明.md §1")
|
||||
"详见 docs/UI设计/RemoDispBus协议与接收设计说明.md §1")
|
||||
|
||||
|
||||
# ----------------------------- 工具函数 -----------------------------
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"""生成 docs/images/BSD网络栈分层.svg —— NET 网络栈分层架构图(纯标准库,无需第三方依赖)。
|
||||
|
||||
由 gen_arch_svg.py 复制改数据区:BSD Socket API 六层结构
|
||||
(docs/BSD_Socket_API_使用指南.md §2.1):
|
||||
(docs/网络/BSD_Socket_API_使用指南.md §2.1):
|
||||
应用层任务 → 消息队列 → netTask → net_socket 核心 → ch395f 驱动 → CH395F 硬件。
|
||||
|
||||
用法(仓库根目录,任意 python3):
|
||||
|
||||
@@ -46,7 +46,7 @@ FIELDS = [
|
||||
TITLE = "GD5F2GQ5UE 物理分区布局(256MB)"
|
||||
SUB = "单分区:全片划给 FTL(无静态分区)· 块 = 128KB(64 页 × 2KB)· 共 2048 块"
|
||||
FOOT = ("ftl_fatfs:dhara FTL + FatFS 占用全部 2048 块(偏移 0 ~ 256MB)· "
|
||||
"详见 docs/STM32F4-Base存储架构说明.md §1")
|
||||
"详见 docs/架构设计/STM32F4-Base存储架构说明.md §1")
|
||||
|
||||
|
||||
# ----------------------------- 工具函数 -----------------------------
|
||||
|
||||
@@ -73,7 +73,7 @@ ROWS = [
|
||||
[L_SPI],
|
||||
]
|
||||
|
||||
FOOT = "数据路径:应用 → FatFs → dhara FTL → gd5f2gq5ue 驱动 → SPI1 硬件外设(单向依赖)· 详见 docs/STM32F4-Base存储架构说明.md §1"
|
||||
FOOT = "数据路径:应用 → FatFs → dhara FTL → gd5f2gq5ue 驱动 → SPI1 硬件外设(单向依赖)· 详见 docs/架构设计/STM32F4-Base存储架构说明.md §1"
|
||||
|
||||
|
||||
# ----------------------------- 工具函数 -----------------------------
|
||||
|
||||
Reference in New Issue
Block a user