Skip to content

docs(axbuild): document unified image management, new commands, and C#1472

Merged
ZR233 merged 10 commits into
devfrom
doc
Jul 3, 2026
Merged

docs(axbuild): document unified image management, new commands, and C#1472
ZR233 merged 10 commits into
devfrom
doc

Conversation

@ZCShou

@ZCShou ZCShou commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

No description provided.

ZCShou added 7 commits July 1, 2026 15:39
…ew modules

* Add Wi-Fi control plane handle registry and AP/STA reconfigure docs
* Document deferred poll wake mechanism and IRQ notification path
* Add addr.rs, ip_tos.rs, rx_meta.rs module entries in overview
* Document readiness_poll() replacing register_waker() on Device trait
* Add LISTEN_QUEUE_SIZE constant and DHCP server scope clarification
* Update xtask test path references for asset_network_tests.rs
* Document packetmeta-id and iface-max-addr-count-8 smoltcp features
…ket option updates

* Replace oob-poll task docs with net-poll/device-rx worker wake chain
* Document Wi-Fi STA/AP reconfigure API and control plane write paths
* Update socket option matrix: IP_TOS, SO_PRIORITY, RecvTos, Error, Ttl
* Document poll request coalescing via swap-based publish_poll_request()
* Update RX worker batch size from 1 to DEVICE_RX_WORKER_BATCH (16)
* Clarify init_vsock() single-device registration semantics
* Update IRQ/OOB lock trace and readiness_poll() device model

@mai-team-app mai-team-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Review: docs(axbuild) 文档重构

总体评价

这个 PR 把原来 monolithic 的 build/test 文档按 OS 子系统(ArceOS、StarryOS、Axvisor)拆分为独立目录,同时新增了 Axloader、Std 白名单测试、镜像管理等横切文档。整体组织结构更清晰,链接更新及时,内容质量较高。

CI 状态:所有 check 因 path filter 正确跳过(docs-only 变更),这是预期行为。

发现的问题

  1. ❌ 阻断docs/src/pages/index.js 中链接 /docs/build/test_framework 指向不存在的页面。PR 删除了旧的 docs/docs/build/test/overview.md 但新增的是 docs/docs/build/test.md(路径为 /docs/build/test),landing page 的链接应更新。

  2. ⚠️ 小问题docs/docs/build/arceos/overview.md:60--plat-Dyn 大写 D,应为 --plat-dyn(CLI 参数是小写)。

  3. ⚠️ 小问题docs/docs/build/axvisor/test.md:43详见 运行时环境(../runtime) 不是有效的 Markdown 链接语法,应改为 详见 [Axvisor 运行](../runtime)

其他观察

  • 文档内容与实际 axbuild 代码结构一致(build wrapper、test framework、image management 等)
  • quickstart 文档的链接已正确更新到新路径
  • 表格格式化统一(对齐改进)
  • 无重复/重叠 PR
  • 无合并冲突

Powered by mimo-v2.5-pro

Comment thread docs/src/pages/index.js

@mai-team-app mai-team-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR 复审:docs(axbuild) 文档重构

变更概述

本 PR 将原来集中式的 build/test 文档按 OS 子系统(ArceOS、StarryOS、Axvisor)拆分为独立目录,新增 Axloader、Std 白名单测试、镜像管理、Lint 等横切文档。47 个文件,全部在 docs/ 下,纯文档变更,无 Rust 代码修改。

CI 状态

CI check 因 path filter 跳过(docs-only 变更),符合预期,无需本地 Rust 验证。

前次 review 处理情况

前次 mai-team-app[bot] 的 review 指出了 3 个问题:

  1. 已修复docs/src/pages/index.js/docs/build/test_framework 断链 → 已在 commit 19057c26 中修正。
  2. 未修复docs/docs/build/arceos/overview.md:60--plat-Dyn 大写 D(CLI 参数应为小写 --plat-dyn)。
  3. 未修复docs/docs/build/axvisor/test.md:43详见 运行时环境(../runtime) 不是有效的 Markdown 链接语法。

当前发现

两个遗留问题仍需修复,见下方 inline comment。修复后即可 approve。

其他观察

  • 文档结构清晰,ArceOS/StarryOS/Axvisor 三套子系统各自独立,概述/构建/运行/测试四页一致。
  • quickstart 文档的链接已正确更新到新路径。
  • 无链接指向已删除的旧路径(/docs/build/build/docs/build/run/docs/build/test/)。
  • 无合并冲突,无重复 PR。

Powered by mimo-v2.5-pro

Comment thread docs/docs/build/arceos/overview.md Outdated
Comment thread docs/docs/build/axvisor/test.md Outdated

@ZR233 ZR233 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这次 PR 把 build/test 文档重构成按 ArceOS、StarryOS、Axvisor 分组的页面,并补充 axloader、image、clippy/sync-lint/spin-lint 等命令说明。整体方向是合理的,且当前 diff 只在 docs/ 范围内,没有源码、配置或锁文件变化。

当前还剩两个会直接影响文档可用性的阻断问题,已在行内标出:一个命令参数写成了不存在的 --plat-Dyn,另一个运行时环境引用不是合法 Markdown 链接。前一次 review 中的 landing page 断链已经修复,但这两个问题在当前 head 19057c26e75a991a8036cf61d55baef93021909e 上仍然存在。

验证情况:git diff --check origin/dev...HEAD 通过;gh pr checks 显示 doc 分支没有上报 checks,符合 docs-only 变更没有触发 Rust/运行时 CI 的情况。针对本 PR 的文档声明,我在当前 head 上用 rg 和源码行号复核了旧链接、错误参数和 Markdown 链接语法,确认上述两个问题仍可复现。测试覆盖不适用:本 PR 是文档重构,不引入行为或测试路径;但文档中列出的命令和链接本身需要可执行/可导航。

重复/重叠检查:当前 open PR 中没有另一个同范围的 build docs 重构 PR;本 PR与 base 的区别主要是文档重组,不是重复实现。旧 review thread 中 index 断链已 resolved;两个当前仍有效的文档问题应保持 open,修完后可以再复审。

Comment thread docs/docs/build/arceos/overview.md Outdated
Comment thread docs/docs/build/axvisor/test.md Outdated

@mai-team-app mai-team-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

复审:docs(axbuild) 文档重构

变更概述

本 PR 将原来集中式的 build/test 文档按 OS 子系统(ArceOS、StarryOS、Axvisor)拆分为独立目录,新增 Axloader、Std 白名单测试、镜像管理、Lint 等横切文档。47 个文件,全部在 docs/ 下,纯文档变更,无 Rust 代码修改。

CI 状态

CI check 因 path filter 跳过(docs-only 变更),符合预期,无需本地 Rust 验证。mergeable_state: blocked 是因为前次 review 处于 CHANGES_REQUESTED 状态,非 CI 失败。

前次 review 处理情况

前次共 3 个 CHANGES_REQUESTED review,指出 3 个问题:

  1. 已修复docs/src/pages/index.js/docs/build/test_framework 断链 → 当前 head 无此链接。
  2. 已修复docs/docs/build/arceos/overview.md:60--plat-Dyn → 已改为 --plat-dyn(小写)。
  3. 已修复docs/docs/build/axvisor/test.md:43详见 运行时环境(../runtime) → 已改为 详见 [Axvisor 运行](../runtime)(合法 Markdown 链接)。

GraphQL review thread 确认全部 5 个 thread 均为 isResolved: true

重复/重叠分析

当前 open PR 中无其他 docs 重构或 build docs 相关 PR。PR #1479(release-plz 自动发布)和 PR #1480(ax-task might_sleep 增强)与本 PR 无交集。无重复、无冲突风险。

其他观察

  • 文档结构清晰,ArceOS/StarryOS/Axvisor 三套子系统各自独立,概述/构建/运行/测试四页一致。
  • 新增的 Axloader 文档详细描述了 HTTP Smoke Test 流程,内容准确。
  • quickstart 文档的链接已正确更新到新路径。
  • 无合并冲突。
  • 无剩余阻断问题。

Powered by mimo-v2.5-pro

@mai-team-app mai-team-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

复审:docs(axbuild) 文档重构

变更概述

本 PR 将原来集中式的 build/test 文档按 OS 子系统(ArceOS、StarryOS、Axvisor)拆分为独立目录,新增 Axloader、Std 白名单测试、镜像管理、Lint 等横切文档。47 个文件,全部在 docs/ 下,纯文档变更,无 Rust 代码修改。

CI 状态

CI check 因 path filter 跳过(docs-only 变更),符合预期,无需本地 Rust 验证。mergeable_state: blocked 是因为前次 review 处于 CHANGES_REQUESTED 状态,非 CI 失败。

前次 review 处理情况

前次共 3 个 CHANGES_REQUESTED review,指出 3 个问题:

  1. 已修复docs/src/pages/index.js/docs/build/test_framework 断链 → 当前 head 无此链接。
  2. 已修复docs/docs/build/arceos/overview.md:60--plat-Dyn → 已改为 --plat-dyn(小写)。
  3. 已修复docs/docs/build/axvisor/test.md:43详见 运行时环境(../runtime) → 已改为 详见 [Axvisor 运行](../runtime)(合法 Markdown 链接)。

本地验证

在当前 head af76e69 上通过 grep 确认:

  • docs/src/pages/index.jstest_framework 链接
  • docs/docs/build/arceos/overview.md 仅有 --plat-dyn(小写),无 --plat-Dyn
  • docs/docs/build/axvisor/test.md:43 使用合法 Markdown 链接语法

重复/重叠分析

当前 open PR 中无其他 docs 重构或 build docs 相关 PR。无重复、无冲突风险。

结论

所有前次 review 提出的阻断问题均已修复,文档结构清晰,无剩余阻断问题。Approve。

Powered by mimo-v2.5-pro

@ZR233 ZR233 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

当前 head 重新复核后可以合入。

本轮检查结论:

  • 上次阻塞的两个文档可用性问题已经修复:--plat-Dyn 拼写残留已不存在,运行时环境引用也不再是 malformed Markdown 链接;当前没有未解决 review thread。
  • 范围仍是 docs-only:git diff --name-only --diff-filter=AMR origin/dev...refs/remotes/pr/1472 没有 docs/ 外新增/修改文件。
  • 本地验证:git diff --check origin/dev...refs/remotes/pr/1472 通过,git merge-tree --write-tree origin/dev refs/remotes/pr/1472 能生成 merge tree。GitHub 当前没有 docs 分支 checks,上次一样符合 docs-only path filter 预期。
  • 重叠检查:未看到另一个 open PR 在做同范围的 build/axbuild 文档重构。

# Conflicts:
#	docs/docs/build/build.md
#	docs/docs/build/commands.md
#	docs/docs/build/configuration.md
#	docs/docs/build/run.md

@ZR233 ZR233 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

复审当前 head 3dff08977749ff55bc94f9c4b5d132427d01a6ab,同意合入。

这次更新是合并 dev 后解决文档冲突,范围仍保持 docs-only。重新检查结果:

  • git merge-tree --write-tree origin/dev refs/remotes/pr/1472 成功;
  • git diff --check origin/dev...refs/remotes/pr/1472 通过;
  • git diff --name-only --diff-filter=AMR origin/dev...refs/remotes/pr/1472 当前 36 个文件,全部位于 docs/
  • 旧阻塞项字符串 --plat-Dyntest_framework详见 运行时环境(...) 在当前 PR tree 中均不存在。

GitHub 当前 head 的 CI 只有 docs path-filter 相关 success/skipped 项,符合纯文档变更预期。未发现新的合入阻塞问题。

@ZR233
ZR233 merged commit c9bdbfb into dev Jul 3, 2026
6 checks passed
@ZR233
ZR233 deleted the doc branch July 3, 2026 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants