zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Open

#7 272 ouverte le 30 avr. 2018

Voir sur GitHub
 (1 commentaire) (0 réactions) (1 assigné)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.

Guide contributeur

Stack technique
Aucun
Domaine
documentationdeveloper experience
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
over 1 week
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic understanding of Kconfigfamiliarity with Zephyr RTOS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.