rt-thread icon indicating copy to clipboard operation
rt-thread copied to clipboard

[Feature] 完善Kconfig的help提示

Open Rbb666 opened this issue 1 month ago • 4 comments

Describe problem solved by the proposed feature

目前主线仓库中 libcpu/components/BSP 下大量 Kconfig 文件的 help 描述仍不完整或过于简略,部分选项缺少必要的说明、使用场景、依赖关系提示。

建议重点优化方向: 对 libcpu/components/ 目录下的 Kconfig 中的重要配置项补充并完善 help 描述。补充时需深入阅读对应驱动/模块源码,结合实际实现逻辑和语义,提供准确、完整、易懂的帮助信息,需要做到:

  • 该配置项的具体功能
  • 启用后的行为变化
  • 依赖的其他配置项或硬件要求
  • 典型使用场景
  • 可能的副作用或注意事项

这样能大幅降低开发者在使用 RT-Thread 时选错配置的概率,同时提升整体 BSP 和 CPU 移植文档的完备性。

Rbb666 avatar Nov 17 '25 03:11 Rbb666

认领人(GitHub id):ruanqiuqiu 认领目录:drivers

ruanqiuqiu avatar Nov 18 '25 12:11 ruanqiuqiu

认领人(GitHub id):hzy0117 认领目录:components\finsh components\lwp components\utilities

hzy0117 avatar Nov 18 '25 13:11 hzy0117

@ruanqiuqiu @hzy0117 两位若提交相关的PR,记得关联此ISSUE,谢谢

然后请提交到 copilot/update-kconfig-help-descriptions 这个分支,补充内容,然后我会进行审核

Rbb666 avatar Nov 19 '25 02:11 Rbb666

认领人(GitHub id):hzy0117 认领目录:components\libc components\net

hzy0117 avatar Nov 25 '25 02:11 hzy0117