Closed
[Documentation|文档反馈] quick_start.md"样例验证"章节的预期输出与样例实际输出不符 #148
gao_dafaAdd on  10 days agoClosed at  9 days ago
gao_dafaCollaborators
10 days ago Create

Document Link(文档链接)

Issues Section(问题文档片段)

docs/quick_start.md:283-287
执行成功时输出如下:

```text
rank 0 test pass!
rank 1 test pass!
test pass!

(英文版 `docs/quick_start_en.md:283-287` 为相同的三行输出。)

## Existing Issues(存在的问题)

`01_hcomm_urma_write_read_nbi` 样例的实际输出(样例 README "执行结果"节、以及改名前的旧 README 均为):

```text
[rank 0] hcomm_write_read_nbi | sent to rank 1, received from rank 1 | PASS
[rank 1] hcomm_write_read_nbi | sent to rank 0, received from rank 0 | PASS
RESULT | Example=hcomm_write_read_nbi | Status=PASS

quick_start.md 声称的 rank 0 test pass! 等三行与实际输出完全对不上——即便在样例改名之前,文档输出也与代码输出不一致(git show 94c5e6b~1:.../README.md 可验证)。开发者按文档预期判断"是否执行成功"会误判为失败。

本 issue 与"样例目录路径失效"(另见 issue_1/issue_2)相互独立:路径修好后,输出描述本身仍是错的。

修复建议(Fix Suggestion)

docs/quick_start.md:283-287:

 执行成功时输出如下:

 ```text
-rank 0 test pass!
-rank 1 test pass!
-test pass!
+[rank 0] hcomm_write_read_nbi | sent to rank 1, received from rank 1 | PASS
+[rank 1] hcomm_write_read_nbi | sent to rank 0, received from rank 0 | PASS
+RESULT | Example=hcomm_write_read_nbi | Status=PASS

`docs/quick_start_en.md` 做相同替换。

同时建议:quick_start 该节的"进入样例目录后执行"块(第 271-279 行)中 `./demo` 同样应为 `./hcomm_write_read_nbi tcp://127.0.0.1:29623 <nranks>`(与 build_and_test.md 的修复口径一致,详见 issue_3):

```diff
 make -j
-./demo
+./hcomm_write_read_nbi tcp://127.0.0.1:29623 <nranks>

验证方式:在双卡环境按样例 README 构建运行,比对实际终端输出与文档描述一致。

likedislike
Ggao_dafaCollaborators
10 days ago Added label: documentation
Wwx369Collaborators
9 days ago Associated pull request
Wwx369Collaborators
9 days ago Assign wx369 as responsible person
wx369Collaborators
9 days ago Comments:

您好,感谢您的反馈,相关修改已在进行,近期回合入master

likedislike
Wwx369Collaborators
9 days ago changed custom state from 进行中 to 已完成
Wwx369Collaborators
9 days ago Close issue
CANN-robotCANN-robotCollaborators
9 days ago Added label: resolved