zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Open

#7272 aperta il 30 apr 2018

Vedi su GitHub
 (1 commento) (0 reazioni) (1 assegnatario)C (9144 fork)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

Metriche repository

Star
 (15.249 star)
Metriche merge PR
 (Merge medio 5g 20h) (1000 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Il problema mira a standardizzare la formulazione dei prompt Kconfig nel progetto Zephyr. Inizia esaminando gli esempi di formulazione incoerente forniti nella descrizione del problema. Quindi esamina i file Kconfig nella directory 'drivers/' e fai riferimento a eventuali linee guida di stile o commenti esistenti, in particolare quelli dell'assegnatario. L'obiettivo è creare un insieme di formulazioni coerenti e applicarle a livello di progetto.
Tech stack
Nessuno
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Oltre 1 settimana
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic understanding of Kconfigfamiliarity with Zephyr RTOS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40