执行摘要
该 PR 清理了 CPU 安装文档中关于手动设置 LD_PRELOAD 加载 tcmalloc 的警告和步骤,因为自 PR#37607 起 tcmalloc 已默认捆绑到 CPU wheel 中并自动加载。ARM 文档完全删除 tcmalloc 警告,x86 文档保留 Intel OpenMP 部分。变更仅涉及文档,无代码风险。
功能与动机
PR body 明确指出:"This is no longer needed as tcmalloc now is now bundled into the CPU wheel and ldpreloaded by default since: https://github.com/vllm-project/vllm/pull/37607"。即用户不再需要手动安装和配置 tcmalloc,因此文档中的警告和步骤已过时,容易误导用户进行不必要的操作。
实现拆解
- ARM 文档(
cpu.arm.inc.md):删除 !!! warning "set LD_PRELOAD" 整个警告块(包括安装 tcmalloc、查找路径、设置环境变量的脚本),共删除 14 行。
- x86 文档(
cpu.x86.inc.md):
- 第一处警告块:删除 tcmalloc 相关步骤(安装、查找路径、环境变量),仅保留 Intel OpenMP 的路径查找和设置,并将环境变量设置从
$TC_PATH:$IOMP_PATH:$LD_PRELOAD 简化为 $IOMP_PATH:$LD_PRELOAD。
- 第二处警告块(在 "Install the latest code" 之后):将 "Before use" 改为 "Before using",内容保持不变(仍保留 tcmalloc 和 Intel OpenMP 说明)。注意:此处 tcmalloc 警告未被移除,可能是为了向后兼容或遗漏。
无可用关键源码片段(仅文档变更,无代码)。
评论区精华
- 作者请求审核:
@hmellor @bigPYJ1151 - could you take a look plz?
bigPYJ1151 给予 Approved,无额外评论。
- Mergify 机器人提供了文档预览链接。
风险与影响
风险:极低。仅文档变更,不涉及代码逻辑。唯一需要注意:x86 文档中第二处警告块仍保留了 tcmalloc 说明("Before using vLLM CPU installed via wheels, make sure TCMalloc and Intel OpenMP are installed..."),与 PR 主旨(tcmalloc 已自动加载)不完全一致。未来若 tcmalloc 完全无需手动安装,需进一步清理。
影响:仅影响阅读 CPU 安装文档的用户。ARM 用户不再看到 tcmalloc 警告,减少困惑;x86 用户仍看到 Intel OpenMP 相关警告,tcmalloc 警告部分移除,但仍有一处残留。
关联脉络
- 依赖 PR #37607(将 tcmalloc 捆绑到 CPU wheel 中并默认 ld_preload),该 PR 是本 PR 的前提条件。
- 属于对文档的日常维护,确保与代码行为保持一致。
参与讨论