docs(starry): improve SG2002 and VisionFive 2 quickstart#1582
Merged
Conversation
Contributor
There was a problem hiding this comment.
评审结论:APPROVE
本次仅修改文档 docs/docs/quickstart/starryos.md,为 StarryOS 快速启动文档补充了 VisionFive 2 板卡章节,并统一了 SG2002 章节结构。内容不涉及内核逻辑或板卡运行行为变更。
变更概述
- SG2002 章节重构:拆分为「相关 crates 与驱动」「启动准备与构建」「通过 U-Boot 启动」三个子节,增加了 crates/驱动表格、shell 探针
STARRY_SG2002_BOOT_OK和 test-suit 板测命令说明。 - 新增 VisionFive 2 章节(3.2):按相同结构补充了 JH7110 动态平台、PLIC、RTC、DWMMC、ext4 rootfs 等相关 crates 表格,说明了
visionfive2.toml构建配置、ostool-server 板卡启动流程和STARRY_VISIONFIVE2_SHELL_OK探针。 - 测试入口补充:在 §4 的板测命令中增加了
--board visionfive2条目。
验证结果
cargo fmt --check通过。- 逐一核对了文档中引用的全部路径和配置文件:
os/StarryOS/configs/board/visionfive2.toml— 存在,features 与文档描述一致。os/StarryOS/configs/board/visionfive2-board.toml— 存在,board_type、shell_prefix、shell_init_cmd、success_regex均与文档一致。os/StarryOS/configs/board/licheerv-nano-sg2002.toml/-board.toml/-uboot.toml— 存在,加载地址、探针命令等与文档一致。test-suit/starryos/board-visionfive2/和board-licheerv-nano-sg2002/目录及构建配置均存在。- 代码路径
drivers/ax-driver/src/time/starfive.rs、drivers/ax-driver/src/soc/starfive/、platforms/someboot/src/arch/riscv64/等均存在。
CI 状态
PR 刚创建,CI 尚未运行。由于本次仅修改 Markdown 文档,不涉及 Rust 代码,预期 CI 不会因本次变更失败。
关联 PR 分析
- PR #1581(docs(starryos): document LS2K1000 platform support)同样修改
starryos.md,在同一位置附近新增 Loongson 2K1000 章节。两者属于部分重叠——修改同一个文件但不同的板卡章节。合并时需要注意节号调整(PR #1581 将 2K1000 放在 3.1,SG2002 推到 3.2;PR #1582 保持 SG2002 在 3.1,VisionFive 2 在 3.2)。建议先合并其中一个,另一个 rebase 后调整节号。这不构成阻塞问题。
实现逻辑
文档结构设计合理:以「相关 crates 与驱动 → 启动准备与构建 → U-Boot 启动」为主线,两块板卡使用统一的阅读节奏,同时保留各自的启动差异。VisionFive 2 的 U-Boot 加载地址明确说明由 ostool-server 管理,不写死在仓库中,避免了不准确的配置传播。
未解决的问题
无阻塞问题。PR 内容准确、结构清晰,可以合并。
Powered by deepseek-v4-pro
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
问题
现有 StarryOS 快速启动文档只较完整地说明了 SG2002 的构建和启动方式,缺少 VisionFive 2 的板级依赖、rootfs 准备、U-Boot 启动及运行验证说明。同时,两块开发板的章节结构和命令风格不统一,不便于用户对照操作。
修改内容
补充 VisionFive 2 快速启动文档:
visionfive2构建配置及显式配置文件用法;统一 SG2002 章节结构:
loady、bootm和加载地址等板卡特有信息;STARRY_SG2002_BOOT_OK运行探针和成功判定;实现逻辑
文档按照“相关 crates 与驱动、启动准备与构建、U-Boot 启动”的结构组织。两块开发板使用相同的阅读主线,同时分别保留其实际启动方式和板卡配置差异。
对于仓库中未直接维护的 VisionFive 2 U-Boot 加载地址和具体命令,文档明确其由 ostool-server 板卡配置管理,避免复用 SG2002 参数或记录未经验证的配置。
验证
git diff --check通过;