pingcap/tidb

Add units to the numeric options in the configuration file

Open

#17.847 geöffnet am 8. Juni 2020

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Go (6.186 Forks)batch import
component/configfeature/acceptedhelp wantedtype/feature-requesttype/usability

Repository-Metriken

Stars
 (40.090 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 14T 4h) (346 gemergte PRs in 30 T)

Beschreibung

Feature Request

Is your feature request related to a problem? Please describe:

Most of the numeric configs lack unit. It is easy to confuse users. For example,

https://github.com/pingcap/tidb/blob/b05327509cb3584881815c2605a7537bbc24a8f0/config/config.toml.example#L243

104857600 should be 104857600B and 10737418240 should be 10737418240B or 10G.

Here is another example causing problems: #17434. https://github.com/pingcap/tidb/issues/17434#issuecomment-640209382

Describe the feature you'd like:

  • Add units to the numeric options in the configuration file.
  • Forbid numeric options without units.

Describe alternatives you've considered:

  • Explain the units in documents
  • Explain the units in the configuration file comments

Both of these solutions are not easy to use enough.

Teachability, Documentation, Adoption, Migration Strategy:

Change how the configuration file is parsed.

Contributor Guide

Research-Richtung
Untersuche, wie TiDB Konfigurationsdateien parst, insbesondere numerische Optionen. Sieh dir vorhandene Bibliotheken zur Einheitenanalyse oder Muster im Codebase an und schlage eine Möglichkeit vor, Einheitenunterstützung hinzuzufügen, die für lesbare Werte abwärtskompatibel ist und gleichzeitig Einheiten für neue Konfigurationen vorschreibt.
Tech Stack
go
Domain
backendinfrastructure
Issue Type
Funktion
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.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Goconfiguration parsing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40