| Files | Last commit | Last update |
|---|---|---|
[fix]修复legacy等目录注释中的英文拼写与拼接错误 Co-authored-by: Trouble_Im_in<guanzhongkang1@huawei.com> # message auto-generated for no-merge-commit merge: !5132 merge fix/remaining-comment-concat into master [fix]修复legacy等目录注释中的英文拼写与拼接错误 Created-by: Trouble_Im_in Commit-by: Trouble_Im_in Merged-by: cann-robot Description: ## 描述 修复注释中的英文拼写与拼接错误，提升代码注释可读性。修改覆盖 src/legacy、src/base_comm、src/coll_communicator_mgr、external_depends、pkg_inc 等目录，共 108 个文件、144 行；仅修改注释文本，不改动任何代码逻辑（gcc 剥注释比对修改前后代码零变化）。 修改内容分两类： 1. 拼写错误（代表性）：updata→update、kernal→kernel、pipline→pipeline、sended→sent、channal→channel、ouput→output、intput→input、deivce/Deivce→device、agrs→args、rootrabnk→rootrank、dima→dma、silce→slice、chucksize→chunksize、xsliceszie/ysliceszie→xslicesize/yslicesize、serversion→ser_version、statter→scatter、servere/servre→server、severNum→serverNum、onshot→oneshot、cclbufer→cclbuffer、scrachMem→scratchMem、linkTyp→linkType、Tranport→Transport、multi-sever→multi-server、reducscatter→reducescatter、rtmemcopy→rtMemcpy、locall→local、resRepotPtr→resRepoPtr（与同文件标识符一致）、immeidata/immediata/immedidate→immediate、STADARD→STANDARD、whilte→white、slicecout0/1→sliceCountPart0/1（参数真名）、managent→management、Lauch/FFTSLauch→Launch/FFTSLaunch、Scrach/scrach→scratch、Tansport→Transport、comapre→compare、fasle/flase→false、hanle→handle、leve2→level2、meged→merged（megedRes→mergedRes）、contex→context（contexId→contextId）、reveive→receive、vecotr/vetor→vector、btye→byte、bufer→buffer、clien→client、detroy→destroy、stram→stream、Pipline→Pipeline、Profling→Profiling、NpuDriect→NpuDirect、commComfig→commConfig、dymamically→dynamically 等 2. 缺空格拼接（代表性）：ringallreduce→ring allreduce、ackrecord→ack record、ackwait→ack wait、bitpadding→bit padding、scatterACK→scatter ACK、channelhandle→channel handle、inittime→init time、insever→in server、ctrltask/othertask→ctrl task/other task、scratchmemory→scratch memory、reduceinline→reduce inline、senddevice/recvdevice/sdisplsdevice/rdisplsdevice→send/recv/sdispls/rdispls device、pushback→push_back 等 修改约束： - 未改动宏/枚举/字段/函数名本身（BKF_JOB_FINSIH、INVLID_MOUDLE_ID、remotetRankID、asyncJobLaunch、MEMCPY_SUMBIT_TYPE 等）及日志、代码字符串，避免影响行为；注释中引用这些名称时保持与代码拼写一致 - test 目录（含 test/stub、test/ut、test/legacy、test/hccl_vm）本轮不修改 - binded、adpee、actived 为项目/urma 接口惯用写法保持原样；8pring/4pring（isTopo8pring 拓扑概念）、CNA、OT、CMO、abl 等领域缩写保持原样 - 大小写不规范（如 reducescatter、groupid、usrOUt、hostrdma 等驼峰/大小写形式）及 addfence、needtodo、portgroup、aclmemcpy、endwith 等按评审意见保持原样 - 全部替换仅作用于注释区间（逐字符解析字符串与注释边界），代码中的同名标识符不受影响 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [ ] 📝 文档更新 - [x] 📋 其他，请描述：注释质量修复（英文拼写与拼接错误），纯注释修改，无功能变更 ## 关联的Issue NA ## 测试 已完成的测试用例和场景： 1. gcc 剥注释比对：对全部 108 个改动文件，用 gcc -fpreprocessed -dD -E -P 比对修改前后预处理输出，逐字节一致，证明仅注释变化、代码零改动 2. pre-commit 钩子（clang-format + OAT 增量扫描）全部通过 补充的UT用例：NA（纯注释修改，无逻辑变更，不涉及用例补充） ## 文档更新 无 ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [x] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [x] 🔍 邀请 committer评论/lgtm前的必要检查 - [x] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [x] 📄 代码修改内容已简要描述，相关文档已更新 - [x] 📝 代码注释已更新，代码遵循项目整体代码风格 - [x] 🧪 代码UT测试已更新，覆盖率已达标（纯注释修改，无逻辑变更，不涉及UT） - [x] 🔬 验证方法已更新到"测试"部分 - [x] 🛠️ 代码已通过静态分析工具检查，无错误 - [x] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [x] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!5132 | 2 months ago |