tikv/tikv

Suggestion: make config item names more readable

Offen

#3.503 geöffnet am 23.08.2018

 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)Rust (2.189 Forks)batch import
difficulty/easyhelp wantedtype/enhancement

Repository-Metriken

Stars
 (15.922 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 28T 9h) (68 gemergte PRs in 30 T)

Beschreibung

Feature Request

For commonly used configurations, it's name should be easy to understand by users (i.e. obvious) with as less as technical details as possible. If its meaning can be understood without comments, it is the best.

Some negative examples:

  • TiDB's token-limit

    For users, what is token? Why should I limit token?

    However, names like "max-sessions" is much more obvious.

  • TiKV's readpool

    For users, what is read pool? Shouldn't TiKV contains storage / coprocessor / mvcc etc?

  • TiKV's end-point-xxx

    For users, what is endpoint?

Some positive examples:

  • TiKV's storage.data-dir

    The data directory. Easy to understand.

  • TiKV's server.label

    The label for this server. Easy to understand.

However for advanced configurations (those that we rarely change), the change might be not necessary.

Contributor Guide