RT-Thread / RT-Thread/rt-thread
[Feature] 完善Kconfig的help提示
Open
Nobody has claimed this yet.
Doc
- Dominant language
- C
- Stars
- 12.2k
- Forks
- 5.4k
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 40
Description
Describe problem solved by the proposed feature
目前主线仓库中 libcpu/ 和 components/BSP 下大量 Kconfig 文件的 help 描述仍不完整或过于简略，部分选项缺少必要的说明、使用场景、依赖关系提示。
建议重点优化方向：
对 libcpu/ 和 components/ 目录下的 Kconfig 中的重要配置项补充并完善 help 描述。补充时需深入阅读对应驱动/模块源码，结合实际实现逻辑和语义，提供准确、完整、易懂的帮助信息，需要做到：
- 该配置项的具体功能
- 启用后的行为变化
- 依赖的其他配置项或硬件要求
- 典型使用场景
- 可能的副作用或注意事项
这样能大幅降低开发者在使用 RT-Thread 时选错配置的概率，同时提升整体 BSP 和 CPU 移植文档的完备性。
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.