zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Open

#7,272 opened on Apr 30, 2018

View on GitHub
 (1 comment) (0 reactions) (1 assignee)C (15,249 stars) (9,144 forks)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

Description

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.

Contributor guide

Tech stack
None
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of Kconfigfamiliarity with Zephyr RTOS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.
Be more consistent with Kconfig language · zephyrproject-rtos/zephyr#7272 | Good First Issue