zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Open

#7.272 geöffnet am 30. Apr. 2018

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)C (15.249 Stars) (9.144 Forks)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

Beschreibung

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
Keine
Domain
documentationdeveloper experience
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
over 1 week
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic understanding of Kconfigfamiliarity with Zephyr RTOS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.