文档与代码实现存在三处脱节,用户按文档排查问题会得到与实际不符的结论:
1. 同一语义不同接口返回码不同,文档未说明
asdBlasSetStream
ACL_ERROR_INTERNAL_ERROR
asdFftSetStream
ACL_ERROR_INVALID_PARAM
docs/zh/context/SiP返回码.md 的状态码表未提示该差异,用户按统一语义理解会误判错误来源。
2. 日志系统关键运维参数未文档化
docs/zh/context/SiP返回码.md "日志系统"一节只描述了日志分级,而 core/utils/log_sink_file.cpp:36-39 实现了:
MAX_FILE_SIZE_THRESHOLD
MAX_LOG_FILE_COUNT
DISK_AVAILABEL_LIMIT
这些直接影响运维排障(日志"消失"时无从解释),文档应补充。
3. 环境变量长度上限未文档化
core/utils/include/utils/env.h:20 定义 MAX_ENV_STRING_LEN = 12800,超长环境变量被静默忽略并打 WARN 日志返回 nullptr(docs/zh/Installation_Operation_Guide/environment_variable.md 未提及)。用户设置超长 ASCEND_PROCESS_LOG_PATH 等变量时会静默失效,无从排查。
MAX_ENV_STRING_LEN = 12800
ASCEND_PROCESS_LOG_PATH
纯文档缺失,不涉及代码修改,与实现对齐后可显著降低排障成本。
在 SiP返回码.md 补充返回码差异说明与日志运维参数表;在 environment_variable.md 补充环境变量长度上限及超长行为。
感谢您的反馈,当前@east_yang跟踪处理中。
Describe the current behavior / 问题描述
文档与代码实现存在三处脱节,用户按文档排查问题会得到与实际不符的结论:
1. 同一语义不同接口返回码不同,文档未说明
asdBlasSetStream(core/blas/blas_api.cpp:27)对无效 handle 返回ACL_ERROR_INTERNAL_ERROR;asdFftSetStream(core/fft/fft_api.cpp:842)同场景返回ACL_ERROR_INVALID_PARAM。docs/zh/context/SiP返回码.md 的状态码表未提示该差异,用户按统一语义理解会误判错误来源。
2. 日志系统关键运维参数未文档化
docs/zh/context/SiP返回码.md "日志系统"一节只描述了日志分级,而 core/utils/log_sink_file.cpp:36-39 实现了:
MAX_FILE_SIZE_THRESHOLD)MAX_LOG_FILE_COUNT)DISK_AVAILABEL_LIMIT)这些直接影响运维排障(日志"消失"时无从解释),文档应补充。
3. 环境变量长度上限未文档化
core/utils/include/utils/env.h:20 定义
MAX_ENV_STRING_LEN = 12800,超长环境变量被静默忽略并打 WARN 日志返回 nullptr(docs/zh/Installation_Operation_Guide/environment_variable.md 未提及)。用户设置超长ASCEND_PROCESS_LOG_PATH等变量时会静默失效,无从排查。Impact / 影响
纯文档缺失,不涉及代码修改,与实现对齐后可显著降低排障成本。
Suggested fix / 修复建议
在 SiP返回码.md 补充返回码差异说明与日志运维参数表;在 environment_variable.md 补充环境变量长度上限及超长行为。
Environment / 环境信息