RT-Thread / RT-Thread/rt-thread

[Feature] 完善Kconfig的help提示

Ouverte
#10,941 4 commentaires 2 réactions 1 personne assignée Voir sur GitHub

Personne n'a encore pris cette issue.

Doc
Langage dominant
C
Étoiles
12.2k
Forks
5.4k
Merge moyen
4 j 12 h
PR mergées (30 j)
40

Description

Describe problem solved by the proposed feature

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

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

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

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.