文档基线与后续更新

本页依据 文档基线与后续更新 中记录的 Zephyr main 快照更新。

本次更新基线

  • 核对起始日期:2026-10-04(Asia/Shanghai);更新完成日期:2026-10-05。

  • 官方入口:Zephyr latest。

  • 官网首页展示:main / 4.5.0-rc1。

  • 首页 Report an issue 链接记录的源码提交: 02d743889396e724d53be61e4fe34c484c1d5a97。

  • 对应源码 VERSION 文件记录 4.4.99。官网展示名称和源码版本字段并不完全相同, 因此复现以完整提交号为准,不由网页标题推断 Git 标签。

可追溯记录位于仓库 doc/upstream-baseline.json,包含每页对应上游文件、固定提交 URL 和下载内容 SHA-256。网页链接保留 latest 方便继续查阅,固定源码链接用于复核本次修改。

更新范围

本次核对并更新仓库已有中文 RST 教程,覆盖项目介绍、开发环境、West、VS Code、 内核同步与数据传递、Flash 驱动、存储、日志、Shell 和格式化输出。 新增通用入门、应用构建、迁移和维护入口。

中文教程以解释与可用示例为主,并未逐页翻译上游整个文档站。 原资料中的整段旧私有实现已改成当前行为说明和固定提交源码入口, 便于学习时区分公共 API 与随版本变化的实现。 现有页面路径及主要显式标签继续保留。 历年会议 PDF/PPT 是发表当年的资料,按 历年会议与讲义资料 归档。

核对方法与实际验证范围

  1. 从官方文档首页取得构建提交号,下载相应提交的文档和公共头文件。

  2. 对安装版本、命令、板名、函数签名和弃用声明逐项核对。

  3. 用 Sphinx 严格 HTML 构建检查 RST、目录和交叉引用。

  4. 检查引用的上游文档链接,并记录可复核的源文件摘要。

本次严格 HTML 构建通过,42 页全部进入目录,原有显式锚点已核对保留。 外链检查已通过 56 个不同地址,后续补充的邮箱源码地址也已单独确认可访问, 共核对 57 个地址。GitHub 检查期间出现限流,重试后通过。 网页 URL 的可访问性与页内锚点检查是不同事项,本次未检查外部页面的锚点。

文档构建成功不代表已经在开发板上验证所有示例。 本次没有安装完整固件开发 SDK,也没有执行烧录、擦除或 NVS 写入; 硬件相关代码已按当前接口与明确前提编写,应用集成仍需在实际目标上验证。

下一次更新

  1. 选择固定发布版或新的 main 提交,记录核对日期与官方页面版本。

  2. 对 doc/upstream-baseline.json 对应的上游文件比较变化,先处理迁移指南。

  3. 同时检查公共头文件、Kconfig 与示例所在目录,不能只对比说明文字。

  4. 更新中文解释、命令与示例,保持页面路径和重要引用标签。

  5. 使用 构建与维护中文文档 中的严格构建命令,修复警告与失效链接。

  6. 在实际开发板上验证所涉及的驱动、时序和存储兼容性,再记录硬件验证结果。

固定文档环境与固定 Zephyr 源码是不同事项。 文档站依赖由 doc/requirements-doc.txt 记录,固件开发依赖由所选 Zephyr 工作区决定。