已合并
[fix]: clean up wording and typos #4864
Liang Xuheng创建于 8月26日
[fix]: clean up wording and typos #4864
已合并
Liang Xuheng创建于 8月26日
Liang Xuheng成员
8月26日

描述

本 PR 批量修复 Clean Code 扫描发现的拼写和语法问题。

  • 修正日志、注释中的拼写、语法和表达问题
  • 涉及 97 个文件
  • 不修改标识符、接口和执行逻辑,属于低风险文案清理

变更类型

请选择本次引入的变更类型:

关联的Issue

测试

已完成的测试用例和场景:
1.
2.

补充的UT用例:

文档更新

合入检查

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 Liang Xuheng 的贡献)
LLiang Xuheng成员
8月26日 创建了 pull request,commit 398db1a4
atomgit-bot
atomgit-bot
8月26日 评论:

变更摘要

本 PR 是一次纯文案清理([fix] 类型),针对集合通信库中大量日志与报错信息进行拼写、语法和格式修正,涉及内存注册管理(roce_mem.cc、urma_mem.cc)、RDMA 代理(ra_ctx.c、ra_host.c、ra_socket.c)、集合通信算法模板/执行器(all_gather_*、all_reduce_*、alltoallv_*、reduce_scatter_* 等)、框架通信与任务异常处理等多个模块。所有改动均停留在日志字符串层面,未改变任何功能逻辑、接口或数据结构。

主要改动

  • 修复日志格式串与实参不匹配:在 comm_kfc_dispatcher.cc 中修正 Group sync 失败日志的参数顺序(由 groupId, handleId, ret 改为 curGroupIdx, groupId, handleId, ret,与格式符一一对应);在 ccu_rep_context.cc 中将写死的 deafultDieId[0] 改为 defaultDieId[%u] 并输出实际 dieId;在 coll_reduce_ring_for_910_93_executor.cc 中将错误的格式符 0x%01611x 改为 0x%016llx;在 task_exception_handler.cpp 中删除 PrintCcuErrorLog 报错信息末尾多余且错误的 %s/__func__ 实参。
  • 修正日志中的错误标识符:统一纠正日志文案中拼写错误的类名、函数名与变量名,如 RankInfoDispather → RankInfoDispatcher、SplictStream → SplitStream、jettyHanlde → jettyHandle、BroadBastStar → BroadcastStar、ouput_mem_ → output_mem_、recommanded → recommended、lcoalSize → localSize、errorno → errno 等。
  • 规范化英文语法表达:将日志中的中式/错误语法改为标准表达,如 is not exist → does not exist、must greater or equal → must be greater than or equal、not need to → no need to、silce → slice、begain → begin、simutaneously → simultaneously、invilad → invalid、form → from 等,覆盖 HCCL_* 日志、hccp_err 错误串及 C 语言模块调试输出。
  • 补齐日志格式与文件规范:修复多处日志格式串与实参之间缺失的空格(如 "failed" "(used by other RemoteRank)"、"phyId[%u]invalid" 等),删除重复词(如 "failed failed, return[%d]" → "failed, return[%d]"),并为 bkf_suber_conn_fsm.c、ra_ctx.c 等文件补充文件末尾换行。
likedislike
不准确?
atomgit-bot
atomgit-bot
8月26日 评论:

代码审查

✅ 未发现问题

likedislike
不准确?
CANN-robotCANN-robot成员
8月26日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
8月26日 评论:

CLA Signature Pass

liangxuheng, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
8月26日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
experimental ✅ 劳大钊, 丁炜秦, 杨小渊, 颜业峰 (4/2) ✅ 颜业峰 (1/1)
src/base_comm ✅ 杨小渊, 颜业峰, 王超, 劳大钊, 丁炜秦 (5/2) ✅ 颜业峰, 王超 (2/1)
src/base_comm/resources/hccp ✅ 丁炜秦, 杨小渊, 陈轲, 颜业峰, 劳大钊 (5/2) ✅ 陈轲, 颜业峰 (2/1)
src/coll_communicator_mgr ✅ 颜业峰, 丁炜秦, 杨小渊, 劳大钊 (4/2) ✅ 颜业峰, 丁炜秦 (2/1)
src/legacy/ascend910/algorithm ✅ 丁炜秦, 杨小渊, 颜业峰, 李标智, 劳大钊 (5/2) ✅ 颜业峰, 李标智 (2/1)
src/legacy/ascend910/common ✅ 劳大钊, 丁炜秦, 杨小渊, 颜业峰, 王超 (5/2) ✅ 颜业峰, 王超 (2/1)
src/legacy/ascend910/framework ✅ 杨小渊, 颜业峰, 丁炜秦, 劳大钊 (4/2) ✅ 丁炜秦, 颜业峰 (2/1)
src/legacy/ascend910/framework/common/src/config ✅ 颜业峰, 劳大钊, 丁炜秦, 杨小渊 (4/2) ✅ 颜业峰 (1/1)
src/legacy/ascend910/framework/device/aicpu_kfc ✅ 颜业峰, 劳大钊, 丁炜秦, 杨小渊 (4/2) ✅ 颜业峰 (1/1)
src/legacy/ascend910/platform ✅ 颜业峰, 劳大钊, 丁炜秦, 杨小渊, 王超 (5/2) ✅ 王超, 颜业峰 (2/1)
src/legacy/ascend950/common ✅ 劳大钊, 丁炜秦, 颜业峰, 王超, 杨小渊 (5/2) ✅ 颜业峰, 王超 (2/1)
src/legacy/ascend950/framework ✅ 丁炜秦, 劳大钊, 杨小渊, 颜业峰 (4/2) ✅ 颜业峰, 丁炜秦 (2/1)
src/legacy/ascend950/service/collective/alg ✅ 劳大钊, 丁炜秦, 杨小渊, 颜业峰, 李标智 (5/2) ✅ 颜业峰, 李标智 (2/1)
src/legacy/ascend950/unified_platform ✅ 王超, 颜业峰, 劳大钊, 丁炜秦, 杨小渊 (5/2) ✅ 王超, 颜业峰 (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)
likedislike
CANN-robotCANN-robot成员
8月26日 将leabclove,yanglianxiang2,yanqingshang,linyf950,yanzhenghang,chenliang267,wqtshg_wt,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,yangxiaoyuan,laodazhao1,yangshaohua,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,lilin_137,hulk1997,ouyangxizi,one_random设为评审人
CANN-robotCANN-robot成员
8月26日 将leabclove,yanqingshang,yanzhenghang,wqtshg_wt,yanyefeng,chenhao_,dingweiqin_57,wenxuemin,chenke2026,bz_lee,Innoecho,temper7620设为审查人
LLiang Xuheng成员
8月26日 修改了pull request 的描述
Liang Xuheng成员
8月26日 评论:

/compile

likedislike
LLiang Xuheng成员
8月26日 预合并成功(commit_id: 090e2007723226933e9db837d94eb84e4b0aa257)
CANN-robotCANN-robot成员
8月26日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
8月26日 评论:

流水线任务触发成功
任务链接 [2cb1c713d8814db79390da2fb63123a4][流水线指导]

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
Check_Pr ✅ SUCCESS >>>>>
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
StaticCheck_codespell ✅ SUCCESS
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
ST_Test ✅ SUCCESS
API_Check ✅ SUCCESS >>>>>
codecheck ✅ SUCCESS >>>>>
codecheck_style ✅ SUCCESS >>>>>
UT_Test ✅ SUCCESS >>>>>
precommit ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>
PreSmoke_A3_npupool ✅ SUCCESS >>>>>

[2026-08-26 16:49:02]    CI执行结束

likedislike
CANN-robotCANN-robot成员
8月26日 添加了label:api-check-pass
CANN-robotCANN-robot成员
8月26日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
8月26日 添加了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
8月26日 评论:
流水线 PR-pipeline_cann_hcomm#18868 [ commitID:2e40b5b2 ] 已完成
likedislike
laodazhao1成员
8月27日 评论:

/lgtm

likedislike
RocketHcgs
RocketHcgs成员8月27日进行代码检视2
src/base_comm/primitives/api_c_adpt/hcomm_channel_c_adpt.cc
@@ -365,3 +365,3 @@
365365 CHK_PTR_NULL(channels);
366366 CHK_PRT_RET(
367- (channelNum == 0), HCCL_ERROR("[%s]Invalid channelNum, channelNum[%u]", __func__, channelNum), HCCL_E_PARA);
367+ (channelNum == 0), HCCL_ERROR("[%s] Invalid channelNum, channelNum[%u]", __func__, channelNum), HCCL_E_PARA);
RocketHcgs
RocketHcgs8月27日评论:

【代码风格】函数名称打印是用[%s] + __func__还是直接打印,需要统一吗

likedislike
Liang Xuheng成员
8月28日 评论:

这个问题本次PR暂不分析吧,只做cleancode问题的解决

57_Viking
57_Viking成员
8月28日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
8月28日 添加了label:lgtm
57_Viking
57_Viking成员
8月28日 评论:

/approve

likedislike
LLiang Xuheng成员
8月28日 解决了最后一个问题
bz_lee成员
8月28日 评论:

/approve

likedislike
yangxiaoyuan
yangxiaoyuan成员
8月28日 评论:

/lgtm

likedislike
chenke2026成员
8月28日 评论:

/approve

likedislike
temper7620成员
8月28日 评论:

/approve

likedislike
philo
philo成员
8月28日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
8月28日 添加了label:approved
CANN-robotCANN-robot成员
8月28日 合入了pull request