已合并
[反合][docs]根据doc tools扫描结果优化资料 #418
whytao创建于 28 天前
[反合][docs]根据doc tools扫描结果优化资料 #418
已合并
whytao创建于 28 天前
whytao
whytao
28 天前

合入来源

问题/功能描述

修改方案描述

是否涉及UT/ST

  • [x ] 否(说明理由)

开发自检

likedislike
Pull Request已成功合入, 合并人@zhangjinshi
(感谢 whytao 的贡献)
whytaowhytao
28 天前 关联了issue:[Doc]: 需要添加资料门禁
atomgit-bot
atomgit-bot
28 天前 评论:

变更摘要

本次 PR 主要基于文档工具(doc tools)的扫描结果,对 memcache 项目的资料文件进行了批量优化和修正,涉及 24 个文件、新增约 2431 行、删除约 1901 行。变更聚焦于修复文档中的格式问题、内容错误以及一致性缺陷,以提升资料质量和可维护性,关联 issue #190

主要改动

  • 文档格式规范化:根据 doc tools 扫描结果,对大量文档文件进行了格式调整和内容修正,包括但不限于 Markdown 语法修复、表格对齐、代码块标注规范化等。
  • 文档内容修正:修复了资料中存在的描述错误、过期信息以及不一致的术语使用,确保文档与实际功能行为保持一致。
  • 文档结构优化:调整了部分文档的章节组织与层级结构,使资料在逻辑上更加清晰,便于用户查阅和理解。
likedislike
atomgit-bot
atomgit-bot
28 天前 评论:

代码审查

No co-located secondary defects found. The neighborhood of the reported finding is clean.


关闭总结

本次审查覆盖了全部 18 个变更文件,逐文件审查结论如下:

文件 审查结果
README.md 无问题 — doc/docs/ 路径更新及格式优化
docs/SECURITYNOTE.md 无问题 — 标题结构调整、安全说明格式优化
docs/c_cpp_naming.md 无问题 — 仅重命名,空 diff
docs/devcontainer_quickstart.md 无问题 — NOTE 块化、列表格式化
docs/install_run.md 1 个 P2 问题 — MemFabric 链接更新不一致
docs/install_whl.md 同上(同一不一致性问题)
docs/memcache_c++_api.md 无问题 — API 文档大规模格式化/结构化优化
docs/memcache_c_api.md 无问题 — API 文档大规模格式化/结构化优化
docs/memcache_config.md 无问题 — 标题层级调整、表格转义修复
docs/memcache_python_api.md 无问题 — 仅重命名,空 diff
docs/memcache_restful_api.md 无问题 — 标题层级从 h3→h2 的结构化调整
docs/memcache_ssd_usage.md 无问题 — 代码块语言标注及文本微调
example/benchmark/README.md 无问题 — 表格中 * 转义修复
example/cpp/README.md 无问题(变更行),但含未更新的旧 MemFabric 链接
example/examples.md 无问题 — 添加标题及代码块语言标注
example/python/README.md 无问题(变更行),但含未更新的旧 MemFabric 链接
pre-commit/README.md 无问题 — 添加标题及说明文字
script/README.md 无问题 — 标题层级调整、代码块语言标注

按优先级统计:P0: 0,P1: 0,P2: 1,P3: 0。

整体风险评估:低风险。本次变更主要为文档目录迁移(doc/docs/)及 Markdown 格式规范化,不涉及任何代码逻辑、安全配置或运行行为变更。唯一需要关注的是 MemFabric 安装文档链接在部分文件中被更新而在另一些文件中遗漏,导致文档间指引不一致——建议在合入前同步更新 example/cpp/README.mdexample/python/README.md 中的对应链接。

类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
ascend-robot
ascend-robot成员
28 天前 评论:
流水线 PR-pipeline_memcache#1723 (重试第1次) [ commitID:3daea7ee ] 已完成
阶段 任务名 状态 详情
编译构建 Build_memcache >>>
恶意代码检查 Antipoison_memcache >>>
编码安全与规范检查 pre-commit >>>
CodeCheck_memcache >>>
开源片段检查 SCA_memcache >>>
开发者测试 UT_memcache >>>
流水线 PR-pipeline_memcache >>>
此流水线已支持下列评论快捷指令,仅PR创建者和白名单成员评论有效
  • compile : 运行流水线
  • retry : 重试流水线所有失败子任务
  • retry <任务名> : 仅重试指定失败子任务
  • stop : 停止流水线
likedislike
Xxiangjie10成员
28 天前 添加了label:pr-audit-failed
xiangjie10成员
28 天前 评论:
🔍 PR 规范审计未通过,以下项目需要修正:
  • PR 新增代码 2431 行超过 1000 行,且标题未标注"反合"

请修正后重新提交,或联系仓库管理员。

likedislike
ascend-robotascend-robot成员
28 天前 添加了label:ascend-cla/yes
ascend-robot
ascend-robot成员
28 天前 评论:

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


PR Approval Progress

⚠️ This PR does not yet meet the following requirements:lgtm (requires ≥ 3 person(s) per module)、approve (requires ≥ 1 person(s) per module)

Module Approval Details

module lgtm status approve status
repo-Ascend/memcache ❌ (0/3)(You can also ask: lijinghan1, 孙文林, adamcaoyang, shilinlee_com, yangpeng197) ❌ (0/1)(You can also ask: wang-ruiju, yangjingyao, weihaoran1, 陈元明, liu1103xwxw)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

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

likedislike
ascend-robotascend-robot成员
28 天前 添加了label:ci-pipeline-running
ascend-robotascend-robot成员
28 天前 删除了label:ci-pipeline-running
ascend-robotascend-robot成员
28 天前 添加了label:ci-pipeline-passed
whytaowhytao
28 天前 修改标题为 “[反合][docs]根据doc tools扫描结果优化资料”,原标题为“【docs】根据doc tools扫描结果优化资料”
whytao
whytao
28 天前 评论:

/docs-retest

likedislike
whytao
whytao
28 天前 评论:

/retest

likedislike
atomgit-bot
atomgit-bot28 天前进行代码检视1
docs/install_run.md
@@ -62,3 +62,3 @@
6262### 安装MemFabric
6363 
64-MemCache依赖MemFabric,需要先安装MemFabric,详细安装方法可参考[MemFabric使用指导](https://gitcode.com/Ascend/memfabric_hybrid/blob/master/doc/installation.md)
64+MemCache依赖MemFabric,需要先安装MemFabric,详细安装方法可参考[MemFabric使用指导](https://gitcode.com/Ascend/memfabric_hybrid/blob/develop/docs/installation.md)
atomgit-bot
atomgit-bot28 天前评论:

🟡 Medium Priority

本次 diff 在 docs/install_run.mddocs/install_whl.md 中将 MemFabric 安装文档链接从 https://gitcode.com/Ascend/memfabric_hybrid/blob/master/doc/installation.md 更新为 https://gitcode.com/Ascend/memfabric_hybrid/blob/develop/docs/installation.md(分支从 master 变为 develop,路径从 doc/ 变为 docs/),但 example/cpp/README.md(第18行)和 example/python/README.md(第19行)中的相同链接未被更新,仍然指向 blob/master/doc/installation.md

影响:用户按不同文档操作时会得到不一致的指引。如果 MemFabric 仓库的 master 分支已不再维护或 doc/ 目录已迁移,旧链接可能失效或指向过时内容。

触发条件:用户按 example/cpp/README.mdexample/python/README.md 的指引点击 MemFabric 安装链接。

建议:将 example/cpp/README.mdexample/python/README.md 中相同的 MemFabric 安装链接也更新为 https://gitcode.com/Ascend/memfabric_hybrid/blob/develop/docs/installation.md,保持文档一致性。

likedislike
whytaowhytao
28 天前 推送  1 个提交:3daea7ee-修改example的readme中的链接
ascend-robotascend-robot成员
28 天前 删除了label:ci-pipeline-passed
ascend-robotascend-robot成员
28 天前 添加了label:ci-pipeline-running
ascend-robotascend-robot成员
28 天前 添加了label:stat/needs-squash
ascend-robotascend-robot成员
28 天前 删除了label:ci-pipeline-running
ascend-robotascend-robot成员
28 天前 添加了label:ci-pipeline-failed
zhouyi
zhouyi
28 天前 评论:

/docs-retest

likedislike
cctvcat
28 天前 评论:

/docs-retest

likedislike
ascend-robot
ascend-robot成员
28 天前 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
28 天前 添加了label:docs-ci-pipeline-running
ascend-robot
ascend-robot成员
28 天前 评论:

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
28 天前 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
28 天前 添加了label:docs-ci-pipeline-success
whytao
whytao
28 天前 评论:

/retest

likedislike
whytao
whytao
28 天前 评论:

retry

likedislike
ascend-robotascend-robot成员
28 天前 删除了label:ci-pipeline-failed
此处折叠了10条事件消息 查看更多
Zzhangjinshi成员
28 天前 合入了pull request