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 (9,144 forks)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

Repository metrics

Stars
 (15,249 stars)
PR merge metrics
 (Avg merge 4d 21h) (1,000 merged PRs in 30d)

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

Research direction
Analyze the inconsistent Kconfig prompts in the repository, create a standardized template, and update all Kconfig files accordingly. Develop a code review guideline for consistency.
Tech stack
c
Domain
build system
Issue type
Refactor
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50