zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Open

#7,272 创建于 2018年4月30日

在 GitHub 查看
 (1 评论) (0 反应) (1 负责人)C (15,249 star) (9,144 fork)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

描述

The language used in Kconfig prompts is inconsistent. This presents application developers a messy and potentially confusing user interface (when the variation in language actually intends to communicate a variation).

Examples of phrasing used to communicate that a driver should be enabled in "Device Drivers":

Device Drivers:
  <driver>
  <driver> driver
  <driver> drivers
  <driver> Drivers
  <driver> drivers options
  <driver> support
  <driver> Support
  <driver> Configuration
  <driver> Device Drivers
  Enable <driver> driver
  add support for <driver> Drivers

Definition of Done:

  • Port the Kconfig language used to be more consistent.
  • Develop guidelines that can be used in code-review (and during porting) to enforce consistency.

贡献者指南

技术栈
无
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic understanding of Kconfigfamiliarity with Zephyr RTOS
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
The issue aims to standardize Kconfig prompt phrasing across the Zephyr project. Start by reviewing the examples of inconsistent phrasing provided in the issue description. Then examine Kconfig files in the 'drivers/' directory and refer to any existing style guidelines or comments, especially from the assignee. The goal is to create a set of consistent phrasings and apply them project wide.